{ "openapi": "3.0.1", "info": { "title": "Avionte API (Crawled Reference Merge)", "description": "Merged OpenAPI document crawled from https://developer.avionte.com/reference/. Endpoint paths preserve any original server pathname prefix when present. Excluded server prefixes: /talent.", "version": "3.26.7-r93" }, "servers": [ { "url": "https://api.avionte.com" } ], "paths": { "/front-office/v1/company/{companyId}/company-category-tag": { "post": { "tags": [ "Companies" ], "summary": "Add Company Category Tag", "description": "Adds a category tag to the company profile. Added tag is displayed in the *Categories / Details* section of the *Tags* tab on the company’s profile page. Tags may comprise the information that can help to further categorize the company and make the company profile more searchable.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a category tag to the company profile. Added tag is displayed in the *Categories / Details* section of the *Tags* tab on the company’s profile page. Tags may comprise the information that can help to further categorize the company and make the company profile more searchable.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/add-company-category-tags.md", "operationId": "AddCompanyCategoryTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "An identifier for the company to which the category tag is being added.", "required": true, "schema": { "type": "string" }, "example": "17488" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyCategoryTag" } } }, "required": true }, "responses": { "201": { "description": "The created company category tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyCategoryTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/add-company-category-tags.md", "x-original-operationId": "Add Company Category Tags" }, "get": { "tags": [ "Companies" ], "summary": "Get Company Category And Details", "description": "Returns a list of company category and details. Shown in the BOLD user interface under the Tags tab for the specified company.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of company category and details. Shown in the BOLD user interface under the Tags tab for the specified company.\n\nSource reference: https://developer.avionte.com/reference/getcompanycategoryanddetails.md", "operationId": "GetCompanyCategoryAndDetails", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "An identifier for the company whose category and details are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17488" } ], "responses": { "200": { "description": "A list of company category and details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfArrayOfCompanyCategoryTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanycategoryanddetails.md" }, "delete": { "tags": [ "Companies" ], "summary": "Remove Company Category Tag", "description": "Permanently deletes the specified company category tag from the *Tags* tab of the specified company profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified company category tag from the *Tags* tab of the specified company profile.\n\nSource reference: https://developer.avionte.com/reference/remove-company-category-tags.md", "operationId": "RemoveCompanyCategoryTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "An identifier for the company from which the category tag is being removed.", "required": true, "schema": { "type": "string" }, "example": "17488" }, { "name": "itemId", "in": "query", "description": "An identifier for the category tag that is being removed.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "The removed company category tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyCategoryTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/remove-company-category-tags.md", "x-original-operationId": "Remove Company Category Tags" } }, "/front-office/v1/company/{companyId}/company-tag": { "post": { "tags": [ "Companies" ], "summary": "Add Company Tag", "description": "Adds a tag to the company profile. Added tag is displayed in the *Tags* section of the *Tags* tab on the company’s profile page. Tags may comprise the information that can help to further categorize the company and make the company profile more searchable.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a tag to the company profile. Added tag is displayed in the *Tags* section of the *Tags* tab on the company’s profile page. Tags may comprise the information that can help to further categorize the company and make the company profile more searchable.\n\n> ⚠️\n>\n> Although the **tagId** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/add-company-tags.md", "operationId": "AddCompanyTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "An identifier for the company to which the tag is being added.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyTag" } } }, "required": true }, "responses": { "201": { "description": "The created company tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/add-company-tags.md", "x-original-operationId": "Add Company Tags" }, "delete": { "tags": [ "Companies" ], "summary": "Remove Company Tag", "description": "Permanently deletes the specified company tag from the *Tags* tab of the specified company profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified company tag from the *Tags* tab of the specified company profile.\n\nSource reference: https://developer.avionte.com/reference/remove-company-tags.md", "operationId": "RemoveCompanyTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "An identifier for the company from which the tag is being removed.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "itemId", "in": "query", "description": "The identifier for the Company Tag to be removed.", "required": true, "schema": { "type": "string" }, "example": "28442" } ], "responses": { "200": { "description": "The removed company tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/remove-company-tags.md", "x-original-operationId": "Remove Company Tags" } }, "/front-office/v1/contact/{contactId}/skill-category-tags": { "post": { "tags": [ "Contacts" ], "summary": "Add a Contact Category Tag", "description": "Adds a category tag to the profile of the contact. Added tag is displayed on the *Tags* tab of the contact profile page. Tags may comprise the information that can help to further categorize the contact and make their profile more searchable.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a category tag to the profile of the contact. Added tag is displayed on the *Tags* tab of the contact profile page. Tags may comprise the information that can help to further categorize the contact and make their profile more searchable.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/add-contact-category-tag.md", "operationId": "AddContactCategoryTag", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactCategoryTag" } } }, "required": true }, "responses": { "201": { "description": "The created contact category tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactCategoryTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/add-contact-category-tag.md", "x-original-operationId": "Add Contact Category Tag" }, "delete": { "tags": [ "Contacts" ], "summary": "Remove a Contact Category Tag", "description": "Permanently deletes the specified contact category tag from the *Tags* tab of the specified contact profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified contact category tag from the *Tags* tab of the specified contact profile.\n\nSource reference: https://developer.avionte.com/reference/remove-contact-category-tag.md", "operationId": "RemoveContactCategoryTag", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The removed contact category tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactCategoryTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/remove-contact-category-tag.md", "x-original-operationId": "Remove Contact Category Tag" } }, "/front-office/v1/talent/{talentId}/everify": { "post": { "tags": [ "Talent" ], "summary": "Add an E-Verify Record", "description": "Adds information about the talent’s E-Verify record. The information about the record is displayed in the *Personal Information* section of the *Tax* tab of the talent’s profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds information about the talent’s E-Verify record. The information about the record is displayed in the *Personal Information* section of the *Tax* tab of the talent’s profile page.\n\nSource reference: https://developer.avionte.com/reference/add-everify-record.md", "operationId": "AddEverifyRecord", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose E-Verify case should be added.", "required": true, "schema": { "type": "string" }, "example": "174882" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__EverifyDomainModel" } } }, "required": true }, "responses": { "201": { "description": "The created E-Verify record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__EverifyDomainModel" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/add-everify-record.md", "x-original-operationId": "Add Everify Record" }, "get": { "tags": [ "Talent" ], "summary": "Get E-Verify Records", "description": "Returns details about the E-Verify records for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the E-Verify records for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/get-everify-record.md", "operationId": "GetEverifyRecord", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose E-Verify case record is being retrieved.", "required": true, "schema": { "type": "string" }, "example": "184992" } ], "responses": { "201": { "description": "A list of E-Verify records for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfEverifyDomainModel" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-everify-record.md", "x-original-operationId": "Get Everify Record" } }, "/front-office/v1/job/{jobId}/skills/add": { "post": { "tags": [ "Jobs" ], "summary": "Add Job Skills", "description": "Adds new skills to the skill set for a particular job. Skills are displayed in the *Position Categories and Skill Set* section of the job profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds new skills to the skill set for a particular job. Skills are displayed in the *Position Categories and Skill Set* section of the job profile page.\n\n> ⚠️\n>\n> Although the **jobSkillId** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/add-job-skills.md", "operationId": "AddJobSkills", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "jobId", "in": "path", "description": "The identifier for the job for which the skills are being added.", "required": true, "schema": { "type": "string" }, "example": "1788427" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJobSkill" } } }, "required": true }, "responses": { "201": { "description": "A list of all job skills for the specified job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__JobSkillResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/add-job-skills.md", "x-original-operationId": "Add Job Skills" } }, "/front-office/v1/placement": { "post": { "tags": [ "Placements" ], "summary": "Add a Placement", "description": "Adds a new placement record to the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a new placement record to the system.\n\nSource reference: https://developer.avionte.com/reference/add-placement.md", "operationId": "AddPlacement", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PlacementDto" } } }, "required": true }, "responses": { "201": { "description": "The placement record that was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Placement" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/add-placement.md", "x-original-operationId": "Add Placement" } }, "/front-office/v1/talent/{talentId}/talent-education-history": { "post": { "tags": [ "Talent" ], "summary": "Add Talent Education History", "description": "Adds information about the education history to the profile of the specified talent record. This information is displayed on the *Education* tab of the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds information about the education history to the profile of the specified talent record. This information is displayed on the *Education* tab of the talent profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/add-talent-education-history.md", "operationId": "AddTalentEducationHistory", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier of the talent for whom the education history should be added.", "required": true, "schema": { "type": "string" }, "example": "17834" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentEducationHistory" } } }, "required": true }, "responses": { "201": { "description": "The talent education history that was successfully added.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentEducationHistory" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/add-talent-education-history.md", "x-original-operationId": "Add Talent Education History" }, "get": { "tags": [ "Talent" ], "summary": "Get Talent Education History", "description": "Returns details about the specified talent’s education from the *Education* tab of the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified talent’s education from the *Education* tab of the talent profile page.\n\nSource reference: https://developer.avionte.com/reference/get-talent-education-history.md", "operationId": "GetTalentEducationHistory", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose education history details are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "27913" } ], "responses": { "200": { "description": "The list of talent education history details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentEducationHistory" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-talent-education-history.md", "x-original-operationId": "Get Talent Education History" } }, "/front-office/v1/talent/{talentId}/talent-questionnaire": { "post": { "tags": [ "Talent" ], "summary": "Add a Talent Questionnaire", "description": "Adds a questionnaire to the profile of the specified talent record. Added questionnaire is displayed on the *Results* tab of the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a questionnaire to the profile of the specified talent record. Added questionnaire is displayed on the *Results* tab of the talent profile page.\n\nSource reference: https://developer.avionte.com/reference/add-talent-questionnaire.md", "operationId": "AddTalentQuestionnaire", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose questionnaire is being added.", "required": true, "schema": { "type": "string" }, "example": "17848" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__WebApplicantTest" } } }, "required": true }, "responses": { "201": { "description": "The added questionnaire.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__WebApplicantTest" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/add-talent-questionnaire.md", "x-original-operationId": "Add Talent Questionnaire" } }, "/front-office/v1/talent/stage": { "post": { "tags": [ "Talent" ], "summary": "Add a Talent Nomination Stage", "description": "Adds a talent nomination stage for a job. This information is displayed on the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a talent nomination stage for a job. This information is displayed on the talent profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/add-talentstage.md", "operationId": "AddTalentStage", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentStage" } } }, "required": true }, "responses": { "201": { "description": "The Talent Nomination Stage that was successfully added.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentStage" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/add-talentstage.md", "x-original-operationId": "Add TalentStage" } }, "/front-office/v1/talent/{talentId}/certification": { "post": { "tags": [ "Talent" ], "summary": "Add a Certification", "description": "Adds a certification tag or a custom tag the company would like to use for the specified talent record. Added tag is displayed on the *Certificates* tab of the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a certification tag or a custom tag the company would like to use for the specified talent record. Added tag is displayed on the *Certificates* tab of the talent profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addcertification.md", "operationId": "AddCertification", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record to add the certification tag to.", "required": true, "schema": { "type": "string" }, "example": "17847" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCertification" } } }, "required": true }, "responses": { "201": { "description": "The newly created certification tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCertification" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addcertification.md" }, "delete": { "tags": [ "Talent" ], "summary": "Remove a Certification", "description": "Permanently deletes the specified certification tag or custom tag for the specified talent record from their profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified certification tag or custom tag for the specified talent record from their profile.\n\nSource reference: https://developer.avionte.com/reference/removecertification.md", "operationId": "RemoveCertification", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record to remove the certification tag from.", "required": true, "schema": { "type": "string" }, "example": "17847" }, { "name": "itemId", "in": "query", "description": "The identifier for the certification tag being removed.", "required": true, "schema": { "type": "string" }, "example": "2745" } ], "responses": { "200": { "description": "The removed certification tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCertification" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removecertification.md" } }, "/front-office/v1/talent/{talentId}/citizenship": { "post": { "tags": [ "Talent" ], "summary": "Add Citizenship", "description": "Adds a citizenship tag or a custom tag the company would like to use for the specified talent record. Added tag is displayed on the *Tags* tab of the talent’s profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a citizenship tag or a custom tag the company would like to use for the specified talent record. Added tag is displayed on the *Tags* tab of the talent’s profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addcitizenship.md", "operationId": "AddCitizenship", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record to which the Citizenship tag should be added.", "required": true, "schema": { "type": "string" }, "example": "18492" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCitizenship" } } }, "required": true }, "responses": { "201": { "description": "The newly created citizenship tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCitizenship" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addcitizenship.md" }, "delete": { "tags": [ "Talent" ], "summary": "Remove Citizenship", "description": "Permanently deletes the specified citizenship tag or custom tag for the specified talent record from their profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified citizenship tag or custom tag for the specified talent record from their profile.\n\nSource reference: https://developer.avionte.com/reference/removecitizenship.md", "operationId": "RemoveCitizenship", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record for which the Citizenship tag should be removed.", "required": true, "schema": { "type": "string" }, "example": "178420" }, { "name": "itemId", "in": "query", "description": "The identifier for the Citizenship tag being removed.", "required": true, "schema": { "type": "string" }, "example": "1420" } ], "responses": { "200": { "description": "The citizenship tag that was removed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCitizenship" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removecitizenship.md" } }, "/front-office/v1/talent/{talentId}/company": { "post": { "tags": [ "Talent" ], "summary": "Add Company Experience", "description": "Adds a company experience tag or a custom tag the company would like to use for the specified talent record. Added tag is displayed on the *Tags* tab of the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a company experience tag or a custom tag the company would like to use for the specified talent record. Added tag is displayed on the *Tags* tab of the talent profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addcompanyexperience.md", "operationId": "AddCompanyExperience", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record to which the company experience tag is being added.", "required": true, "schema": { "type": "string" }, "example": "178924" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCompanyExperience" } } }, "required": true }, "responses": { "201": { "description": "The created company experience tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCompanyExperience" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addcompanyexperience.md" }, "delete": { "tags": [ "Talent" ], "summary": "Remove Company Experience", "description": "Permanently deletes the specified company experience tag or custom tag for the specified talent record from their profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified company experience tag or custom tag for the specified talent record from their profile.\n\nSource reference: https://developer.avionte.com/reference/removecompanyexperience.md", "operationId": "RemoveCompanyExperience", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record from which the Company Experience Tag or Custom Tag is being removed.", "required": true, "schema": { "type": "string" }, "example": "187424" }, { "name": "itemId", "in": "query", "description": "The identifier for the Company Experience Tag or Custom Tag to be removed.", "required": true, "schema": { "type": "string" }, "example": "28442" } ], "responses": { "200": { "description": "The removed company experience tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCompanyExperience" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removecompanyexperience.md" } }, "/front-office/v1/company-restrictions": { "post": { "tags": [ "Companies" ], "summary": "Add Restrictions for a Company", "description": "Adds talent as 'do not place' for a company.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds talent as 'do not place' for a company.\n\nSource reference: https://developer.avionte.com/reference/addcompanyrestriction.md", "operationId": "AddCompanyRestriction", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyDnaDto" } } }, "required": true }, "responses": { "201": { "description": "The created company restriction.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyRestriction" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addcompanyrestriction.md" } }, "/front-office/v1/company/{companyId}/company-source-tag": { "post": { "tags": [ "Companies" ], "summary": "Add Company Source Tag", "description": "Adds a tag for the company source to the company profile page. Added tag is displayed in the *Tags* section of the *Tags* tab of the company profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a tag for the company source to the company profile page. Added tag is displayed in the *Tags* section of the *Tags* tab of the company profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addcompanysourcetags.md", "operationId": "AddCompanySourceTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "The identifier for the company to which the source tag is being added.", "required": true, "schema": { "type": "string" }, "example": "42280" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanySourceTags" } } }, "required": true }, "responses": { "201": { "description": "The created company source tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanySourceTags" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addcompanysourcetags.md" }, "delete": { "tags": [ "Companies" ], "summary": "Remove Company Source Tag", "description": "Permanently deletes a specified tag for the company source from the company profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes a specified tag for the company source from the company profile page.\n\nSource reference: https://developer.avionte.com/reference/removecompanysourcetags.md", "operationId": "RemoveCompanySourceTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "The identifier for the company from which the source tag is being removed.", "required": true, "schema": { "type": "string" }, "example": "42280" }, { "name": "sourceId", "in": "query", "description": "The identifier for the source tag that is being removed.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "The company source tag was successfully removed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanySourceTags" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removecompanysourcetags.md" } }, "/front-office/v1/contact/{contactId}/source-tags": { "post": { "tags": [ "Contacts" ], "summary": "Add a Contact Source Tag", "description": "Adds a tag for the contact source to the contact profile page. Added tag is displayed in the *Tags* section of the *Tags* tab of the contact profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a tag for the contact source to the contact profile page. Added tag is displayed in the *Tags* section of the *Tags* tab of the contact profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addcontactsourcetag.md", "operationId": "AddContactSourceTag", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactSourceTag" } } }, "required": true }, "responses": { "201": { "description": "The contact source tag that was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactSourceTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addcontactsourcetag.md" }, "delete": { "tags": [ "Contacts" ], "summary": "Remove a Contact Source Tag", "description": "Permanently deletes the specified tag for the contact source from the contact profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified tag for the contact source from the contact profile page.\n\nSource reference: https://developer.avionte.com/reference/removecontactsourcetag.md", "operationId": "RemoveContactSourceTag", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The contact source tag that was successfully removed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactSourceTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removecontactsourcetag.md" } }, "/front-office/v1/contact/{contactId}/tags": { "post": { "tags": [ "Contacts" ], "summary": "Add a Contact Tag", "description": "Adds a tag to the contact. Added tags display on the *Tags* tab of the contact’s profile page. Tags may comprise the information that can help to further categorize the contact and make the contact’s profile more searchable.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a tag to the contact. Added tags display on the *Tags* tab of the contact’s profile page. Tags may comprise the information that can help to further categorize the contact and make the contact’s profile more searchable.\n\n> ⚠️\n>\n> Although the **tagId** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addcontacttags.md", "operationId": "AddContactTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactTag" } } }, "required": true }, "responses": { "201": { "description": "The created contact tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addcontacttags.md" }, "delete": { "tags": [ "Contacts" ], "summary": "Delete a Contact Tag", "description": "Permanently deletes the specified tag from the *Tags* tab of the contact profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified tag from the *Tags* tab of the contact profile page.\n\nSource reference: https://developer.avionte.com/reference/deletecontacttags.md", "operationId": "DeleteContactTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactTagId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The removed contact tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/deletecontacttags.md" }, "get": { "tags": [ "Contacts" ], "summary": "Get Contact Tags", "description": "Returns a list of contact tags from the *Tags* tab for the specified contact.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of contact tags from the *Tags* tab for the specified contact.\n\nSource reference: https://developer.avionte.com/reference/getcontacttags.md", "operationId": "GetContactTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A list of contact tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfContactTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcontacttags.md" } }, "/front-office/v1/departments": { "post": { "tags": [ "Departments" ], "summary": "Add a Department", "description": "Adds a new department record to the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a new department record to the system.\n\nSource reference: https://developer.avionte.com/reference/adddepartment.md", "operationId": "AddDepartment", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DepartmentDTO" } } }, "required": true }, "responses": { "201": { "description": "The created department.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Department" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/adddepartment.md" } }, "/front-office/v1/talent/{talentId}/industry": { "post": { "tags": [ "Talent" ], "summary": "Add Industry Experience", "description": "Adds an industry experience tag for the specified talent record. This tag is displayed on the *Tags* tab of the talent’s profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds an industry experience tag for the specified talent record. This tag is displayed on the *Tags* tab of the talent’s profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addindustryexperience.md", "operationId": "AddIndustryExperience", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record to which the Industry Experience tag should be added.", "required": true, "schema": { "type": "string" }, "example": "13948" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentIndustryExperience" } } }, "required": true }, "responses": { "201": { "description": "The created industry experience tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentIndustryExperience" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addindustryexperience.md" }, "delete": { "tags": [ "Talent" ], "summary": "Remove Industry Experience", "description": "Permanently deletes the specified industry experience tag from the specified talent page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified industry experience tag from the specified talent page.\n\nSource reference: https://developer.avionte.com/reference/removeindustryexperience.md", "operationId": "RemoveIndustryExperience", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record for which the Industry Experience tag should be removed.", "required": true, "schema": { "type": "string" }, "example": "13948" }, { "name": "itemId", "in": "query", "description": "The identifier for the Industry Experience Tag to be removed.", "required": true, "schema": { "type": "string" }, "example": "8534" } ], "responses": { "200": { "description": "The removed industry experience tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentIndustryExperience" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removeindustryexperience.md" } }, "/back-office/v1/talent-benefit/enroll": { "post": { "tags": [ "TalentBenefits" ], "summary": "Add Talent Benefit Enrollment", "description": "Adds a talent benefit enrollment to configure recurring employee paycheck deductions. The deduction amount (from Benefit Payroll Deduction enrollment data) is applied during payroll processing for all checks with a check date after the deduction start date. All new enrollments are flagged for review during payroll to ensure the setup is verified before the check is finalized.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a talent benefit enrollment to configure recurring employee paycheck deductions. The deduction amount (from Benefit Payroll Deduction enrollment data) is applied during payroll processing for all checks with a check date after the deduction start date. All new enrollments are flagged for review during payroll to ensure the setup is verified before the check is finalized.\n\n
\n\n\n Either **benefitPayrollContribution** or **benefitPayrollDeduction** object must be included in the request. If both are omitted, the endpoint returns an error.\n\n\n
\n\nSource reference: https://developer.avionte.com/reference/addtalentbenefitenrollment.md", "operationId": "AddTalentBenefitEnrollment", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentBenefitEnrollment" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentBenefitGetResult" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addtalentbenefitenrollment.md" } }, "/front-office/v1/pipeline/talent-stage/add": { "post": { "tags": [ "Talent", "Jobs" ], "summary": "Add Talent to Pipeline Stage", "description": "Adds a talent to a pipeline stage for a job.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-08-05T08:53:11.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a talent to a pipeline stage for a job.\n\n\n Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\n\nSource reference: https://developer.avionte.com/reference/addtalentpipelinestage.md", "operationId": "AddTalentPipeLineStage", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PipelineTalentStage" } } }, "required": true }, "responses": { "201": { "description": "The talent pipeline stage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PipelineTalentStage" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addtalentpipelinestage.md" } }, "/front-office/v1/talent-quick-title": { "post": { "tags": [ "Talent" ], "summary": "Add Talent Quick Title", "description": "Adds a quick search or your custom category tag. Added tag is displayed on the *Tags* tab of the talent profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a quick search or your custom category tag. Added tag is displayed on the *Tags* tab of the talent profile.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addtalentquicktitle.md", "operationId": "AddTalentQuickTitle", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentQuickSearchTitle" } } }, "required": true }, "responses": { "201": { "description": "The added talent quick title.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentQuickSearchTitle" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addtalentquicktitle.md" } }, "/front-office/v1/talent/{talentId}/talent-referrals": { "post": { "tags": [ "Talent" ], "summary": "Add Talent Referrals", "description": "Adds talent referrals by the specified talent and/or for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds talent referrals by the specified talent and/or for the specified talent.\n\n> ⚠️\n>\n> Although the **referralId** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addtalentreferrals.md", "operationId": "AddTalentReferrals", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent for whom the referral is being added.", "required": true, "schema": { "type": "string" }, "example": "178422" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentReferrals" } } }, "required": true }, "responses": { "201": { "description": "The response containing the added talent referrals.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentReferralsResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addtalentreferrals.md" }, "get": { "tags": [ "Talent" ], "summary": "Get Talent Referrals", "description": "Returns details about the specified talent's referrals.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified talent's referrals.\n\nSource reference: https://developer.avionte.com/reference/gettalentreferrals.md", "operationId": "GetTalentReferrals", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose referral details are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "139883" } ], "responses": { "200": { "description": "The talent's referrals.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentReferrals" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentreferrals.md" } }, "/front-office/v1/talent/{talentId}/skills/add": { "post": { "tags": [ "Talent" ], "summary": "Add Talent Skills", "description": "Adds talent skill tags. Added tags are displayed on the *Tags* tab of the talent’s profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds talent skill tags. Added tags are displayed on the *Tags* tab of the talent’s profile page.\n\n> ⚠️\n>\n> Although the **skillId** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addtalentskills.md", "operationId": "AddTalentSkills", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose skills are being added.", "required": true, "schema": { "type": "string" }, "example": "17837" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentSkill" } } }, "required": true }, "responses": { "201": { "description": "The response containing the added talent skills.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentSkillResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addtalentskills.md" } }, "/front-office/v1/talent-source": { "post": { "tags": [ "Talent" ], "summary": "Add Talent Source", "description": "Adds a talent source tag. Added tag is displayed on the *Tags* tab of the talent profile page under *Applicant Source*.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a talent source tag. Added tag is displayed on the *Tags* tab of the talent profile page under *Applicant Source*.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addtalentsource.md", "operationId": "AddTalentSource", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentSource" } } }, "required": true }, "responses": { "201": { "description": "The talent source was successfully added.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentSource" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addtalentsource.md" } }, "/front-office/v1/talent/{talentId}/talenttag": { "post": { "tags": [ "Talent" ], "summary": "Add a Talent Tag", "description": "Add tags to the talent. Added tags display on the *Tags* tab of the talent profile page. Tags may comprise the information that can help to further categorize the talent and make their profile more searchable.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdd tags to the talent. Added tags display on the *Tags* tab of the talent profile page. Tags may comprise the information that can help to further categorize the talent and make their profile more searchable.\n\n> ⚠️\n>\n> Although the **talentTagId** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/addtalenttag.md", "operationId": "AddTalentTag", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record to which the tag should be added.", "required": true, "schema": { "type": "string" }, "example": "18459" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentTag" } } }, "required": true }, "responses": { "201": { "description": "The created talent tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/addtalenttag.md" }, "delete": { "tags": [ "Talent" ], "summary": "Remove a Talent Tag", "description": "Permanently deletes the specified talent tag from the specified talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified talent tag from the specified talent profile page.\n\nSource reference: https://developer.avionte.com/reference/removetalenttag.md", "operationId": "RemoveTalentTag", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record for which the tag should be removed.", "required": true, "schema": { "type": "string" }, "example": "18394" }, { "name": "itemId", "in": "query", "description": "The identifier for the Talent Tag to be removed.", "required": true, "schema": { "type": "string" }, "example": "2894" } ], "responses": { "200": { "description": "The removed talent tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removetalenttag.md" } }, "/front-office/v1/company-restrictions/add-universal-restriction": { "post": { "tags": [ "Companies" ], "summary": "Add Universal Company Restriction", "description": "Adds a talent to the 'Do Not Assign' list universally across multiple tenants for specified companies.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a talent to the 'Do Not Assign' list universally across multiple tenants for specified companies.\n\nSource reference: https://developer.avionte.com/reference/adduniversalcompanyrestriction.md", "operationId": "AddUniversalCompanyRestriction", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__UniversalCompanyRestrictionRequest" } } }, "required": true }, "responses": { "201": { "description": "The response containing the details of the added universal company restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__UniversalCompanyRestrictionResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/adduniversalcompanyrestriction.md" } }, "/authorize/token": { "post": { "tags": [ "Authorization" ], "summary": "Access Token", "description": "Returns an access token.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2024-12-12T12:28:20.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns an access token.\n\nSource reference: https://developer.avionte.com/reference/avionteapikeyauth.md", "operationId": "AvionteApiKeyAuth", "requestBody": { "description": "Request an Access Token", "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "grant_type": { "type": "string", "description": "Credential type (ex. client_credentials). " }, "client_id": { "type": "string", "description": "Unique identifer of client to get auth token for. " }, "client_secret": { "type": "string", "description": "Secret value for client (provided by Avionte). " }, "scope": { "type": "string", "description": "Access scope for auth." } }, "additionalProperties": false, "description": "Required data to process an auth request.", "x-readme-ref-name": "AuthTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The access token to be used to authorize the request." }, "expires_in": { "type": "integer", "description": "The lifetime of the access token in seconds. Default value: 3600 seconds (1 hour).", "format": "int32" }, "token_type": { "type": "string", "description": "The type of the access token. Supported: bearer." } }, "additionalProperties": false, "description": "Successful auth request.", "x-readme-ref-name": "TokenResponse" } } } }, "400": { "description": "Invalid Request", "content": {} }, "403": { "description": "Unauthorized Request", "content": {} } }, "security": [ { "authorize__api_key": [] } ], "x-reference-page": "https://developer.avionte.com/reference/avionteapikeyauth.md" } }, "/front-office/v1/placement/{placementId}/extension/{extensionId}/cancel-schedule-shifts": { "post": { "tags": [ "Placements" ], "summary": "Cancel Placement Schedule Shifts", "description": "Cancel one or more Placement Schedule Shifts by identifiers.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCancel one or more Placement Schedule Shifts by identifiers.\n\nSource reference: https://developer.avionte.com/reference/cancel-placement-schedule-shifts.md", "operationId": "CancelPlacementScheduleShifts", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "placementId", "in": "path", "description": "The unique identifier for the placement.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "extensionId", "in": "path", "description": "The unique identifier for the extension.", "required": true, "schema": { "type": "string" }, "example": "67890" } ], "requestBody": { "description": "A list of schedule shift IDs to be canceled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 123, 456, 789 ] } }, "required": true }, "responses": { "200": { "description": "A list of responses for each canceled schedule shift.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCancelScheduleShiftResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/cancel-placement-schedule-shifts.md", "x-original-operationId": "Cancel Placement Schedule Shifts" } }, "/front-office/v1/talent/certificate/{certificateId}": { "get": { "tags": [ "Talent" ], "summary": "Get a Talent Certificate", "description": "Returns a talent certificate.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a talent certificate.\n\nSource reference: https://developer.avionte.com/reference/certificateget.md", "operationId": "CertificateGET", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "certificateId", "in": "path", "description": "The identifier for the talent certificate instance being requested.", "required": true, "schema": { "type": "string" }, "example": "17488" } ], "responses": { "200": { "description": "The talent certificate.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCertificate" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/certificateget.md" }, "patch": { "tags": [ "Talent" ], "summary": "Update a Talent Certificate", "description": "Updates one or more settings for a talent certificate.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates one or more settings for a talent certificate.\n\nSource reference: https://developer.avionte.com/reference/certificatepatch.md", "operationId": "CertificatePATCH", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "certificateId", "in": "path", "description": "The identifier for the talent certificate instance being updated.", "required": true, "schema": { "type": "string" }, "example": "17844" } ], "requestBody": { "description": "An array of JSON Patch Document operations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfOperation" }, "example": [ { "op": "replace", "path": "/certificateNumber", "value": "1234567" }, { "op": "replace", "path": "/validatedBy", "value": 169386 } ] } }, "required": true }, "responses": { "200": { "description": "The updated talent certificate.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCertificate" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/certificatepatch.md" } }, "/front-office/v1/certificates": { "get": { "tags": [ "Certificates" ], "summary": "Get Certificates", "description": "Returns a list of tenant certificates.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of tenant certificates.\n\nSource reference: https://developer.avionte.com/reference/certificates-1.md", "operationId": "Certificates", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of tenant certificates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfSystemCertificate" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/certificates-1.md" } }, "/front-office/v1/health": { "get": { "tags": [ "Health" ], "summary": "Check the Health", "description": "Returns the operational status of the service.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the operational status of the service.\n\nSource reference: https://developer.avionte.com/reference/checkhealth.md", "operationId": "CheckHealth", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "deepCheck", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The health check results.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Health" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/checkhealth.md" } }, "/back-office/v1/health": { "get": { "tags": [ "Health" ], "summary": "Check the Health", "description": "Returns the operational status of the service.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the operational status of the service.\n\nSource reference: https://developer.avionte.com/reference/checkhealth-1.md", "operationId": "CheckHealth_bc74eb", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "deepCheck", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__Health" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/checkhealth-1.md", "x-original-operationId": "CheckHealth" } }, "/front-office/v1/companies/ids/{page}/{pageSize}": { "get": { "tags": [ "Companies" ], "summary": "Get Company IDs", "description": "Returns a paged list of all company IDs registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of all company IDs registered in the system.\n\nSource reference: https://developer.avionte.com/reference/companyids.md", "operationId": "CompanyIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "description": "The page number to retrieve in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "pageSize", "in": "path", "description": "The number of records to include per page in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "10" } ], "responses": { "200": { "description": "A paged list of company IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 1848945, 1674824, 1485992 ] } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/companyids.md" } }, "/front-office/v1/contact/{contactId}": { "put": { "tags": [ "Contacts" ], "summary": "Update a Contact", "description": "Updates information about the specified contact\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates information about the specified contact\n\nSource reference: https://developer.avionte.com/reference/contactid.md", "operationId": "ContactId", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactDTO" } } }, "required": true }, "responses": { "200": { "description": "The updated contact details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Contact" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/contactid.md" }, "get": { "tags": [ "Contacts" ], "summary": "Get a Contact", "description": "Returns details about the specified contact.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified contact.\n\nSource reference: https://developer.avionte.com/reference/getcontact.md", "operationId": "GetContact", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The contact details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Contact" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcontact.md" } }, "/front-office/v1/contacts/ids/{page}/{pageSize}": { "get": { "tags": [ "Contacts" ], "summary": "Get Contact IDs", "description": "Returns a paged list of all contact IDs registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of all contact IDs registered in the system.\n\nSource reference: https://developer.avionte.com/reference/contactids.md", "operationId": "ContactIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A list of contact IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/contactids.md" } }, "/front-office/v1/contacts/contact-search": { "post": { "tags": [ "Contacts" ], "summary": "Get Contact IDs By Email & Company ID", "description": "Returns a list of contact IDs for the given company ID and email address.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of contact IDs for the given company ID and email address.\n\nSource reference: https://developer.avionte.com/reference/contactsearch.md", "operationId": "ContactSearch", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactSearchDTO" } } }, "required": true }, "responses": { "200": { "description": "The list of contact IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/contactsearch.md" } }, "/front-office/v1/job": { "post": { "tags": [ "Jobs" ], "summary": "Create a Job", "description": "Adds a new job record to the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a new job record to the system.\n\n\n\n
\n\n\n Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\n\nSource reference: https://developer.avionte.com/reference/create-job.md", "operationId": "CreateJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "encoding", "in": "query", "description": "The encoding type for the job description.", "required": false, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__JobDto" } } }, "required": true }, "responses": { "201": { "description": "The created job record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Job" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/create-job.md", "x-original-operationId": "Create Job" } }, "/front-office/v1/job/vms-job": { "post": { "tags": [ "Jobs" ], "summary": "Create a VMS Job", "description": "Adds a new VMS job record to the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a new VMS job record to the system.\n\nSource reference: https://developer.avionte.com/reference/create-vms-job.md", "operationId": "CreateVMSJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__VMSJobDTO" } } }, "required": true }, "responses": { "201": { "description": "The created VMS job record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__VMSJobDTO" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/create-vms-job.md", "x-original-operationId": "Create VMS Job" } }, "/bo-prod/v3/talent/additional-tax": { "post": { "tags": [ "Taxes" ], "summary": "Create Additional Talent Tax", "description": "Creates an additional tax for the talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-15T13:07:39.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates an additional tax for the talent record.\n\nSource reference: https://developer.avionte.com/reference/createadditionaltalenttax.md", "operationId": "CreateAdditionalTalentTax", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__CreateAdditionalTaxPostBody" }, "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentTaxDetailPostResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "409": { "$ref": "#/components/responses/bo_prod__apiResultDuplicate409" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createadditionaltalenttax.md" } }, "/front-office/v1/company": { "post": { "tags": [ "Companies" ], "summary": "Create a Company", "description": "Adds a new company record to the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a new company record to the system.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/createcompany.md", "operationId": "CreateCompany", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyDTO" } } }, "required": true }, "responses": { "201": { "description": "The created company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyDTO" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createcompany.md" }, "put": { "tags": [ "Companies" ], "summary": "Update a Company", "description": "Updates information about the specified company.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates information about the specified company.\n\n> ⚠️\n>\n> When making a PUT request, make sure to include the entire object in the payload for successful updates.\n\nSource reference: https://developer.avionte.com/reference/updatecompany.md", "operationId": "UpdateCompany", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "isDuplicateBypassed", "in": "query", "description": "An indication of whether to bypass the duplicate company name check when updating a company record. If set to `true`, the duplicate name validation is skipped; if set to `false` or not provided, the validation is applied and the update is rejected if a duplicate name is found.", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyDTO" } } }, "required": true }, "responses": { "201": { "description": "The updated company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyDTO" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatecompany.md" } }, "/bo-prod/v3/company/billing-preferences": { "post": { "tags": [ "Billing Preferences" ], "summary": "Create Company Billing Preferences", "description": "Creates new company billing preferences.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:14:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates new company billing preferences.\n\nSource reference: https://developer.avionte.com/reference/createcompanybillingpreferences.md", "operationId": "CreateCompanyBillingPreferences", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "companyGuid", "in": "query", "description": "The unique identifier for a Company record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22" }, { "name": "companyExternalId", "in": "query", "description": "The external ID of the Company entity, used as an alternative to the __CompanyGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Company entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __CompanyGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 366992 }, { "name": "departmentExternalId", "in": "query", "description": "The unique identifier for a Department record, formatted as a UUID.", "schema": { "type": "string" }, "example": 458434 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__CompanyBillingPreferencesBody" }, "responses": { "200": { "$ref": "#/components/responses/bo_prod__CompanyBillingPreferencesGetResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "409": { "$ref": "#/components/responses/bo_prod__apiResultDuplicate409" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "CompanyBillingOptionsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createcompanybillingpreferences.md" }, "get": { "tags": [ "Billing Preferences" ], "summary": "Get Company Billing Preferences", "description": "Returns company billing options for the specified company, based on its unique record identifier.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:14:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns company billing options for the specified company, based on its unique record identifier.\n\nSource reference: https://developer.avionte.com/reference/getcompanybillingpreferences.md", "operationId": "GetCompanyBillingPreferences", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "companyGuid", "in": "query", "description": "The unique identifier for a Company record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22" }, { "name": "companyExternalId", "in": "query", "description": "The external ID of the Company entity, used as an alternative to the __CompanyGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Company entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __CompanyGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 366992 }, { "name": "departmentExternalId", "in": "query", "description": "The unique identifier for a Department record, formatted as a UUID.", "schema": { "type": "string" }, "example": 458434 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__CompanyBillingPreferencesGetResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "CompanyBillingPreferencesController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanybillingpreferences.md" }, "patch": { "tags": [ "Billing Preferences" ], "summary": "Update Company Billing Preferences", "description": "Updates the specified company's billing preferences. Supports `replace` operations for non-identifier fields and `remove` operations for nullable properties.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:14:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the specified company's billing preferences. Supports `replace` operations for non-identifier fields and `remove` operations for nullable properties.\n\nSource reference: https://developer.avionte.com/reference/updatecompanybillingpreferences.md", "operationId": "UpdateCompanyBillingPreferences", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "companyGuid", "in": "query", "description": "The unique identifier for a Company record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22" }, { "name": "companyExternalId", "in": "query", "description": "The external ID of the Company entity, used as an alternative to the __CompanyGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Company entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __CompanyGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 366992 }, { "name": "departmentExternalId", "in": "query", "description": "The unique identifier for a Department record, formatted as a UUID.", "schema": { "type": "string" }, "example": 458434 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ArrayOfPatchOperations" }, "examples": { "Example 1": { "value": [ { "op": "replace", "path": "/invoicePreferences/maxInvoiceAmount", "value": 2500 }, { "op": "replace", "path": "/billingPeriod", "value": "Weekly" }, { "op": "remove", "path": "/invoicePreferences/invoiceStyleGuid" } ] } } } } }, "responses": { "200": { "$ref": "#/components/responses/bo_prod__CompanyBillingPreferencesGetResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "CompanyBillingPreferencesController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatecompanybillingpreferences.md" } }, "/back-office/v2/config-choice": { "post": { "tags": [ "ConfigChoice" ], "summary": "Create a Config Choice", "description": "Creates a Config Choice and returns the newly created object.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a Config Choice and returns the newly created object.\n\nSource reference: https://developer.avionte.com/reference/createconfigchoice.md", "operationId": "CreateConfigChoice", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "requestBody": { "description": "The properties of the Config Choice to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__CreateConfigChoiceProperties" } } }, "required": true }, "responses": { "201": { "description": "201 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__V2ConfigChoice" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createconfigchoice.md" }, "put": { "tags": [ "ConfigChoice" ], "summary": "Update a Config Choice", "description": "Updates the specified Config Choice and returns the updated object.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the specified Config Choice and returns the updated object.\n\nSource reference: https://developer.avionte.com/reference/updateconfigchoice.md", "operationId": "UpdateConfigChoice", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "requestBody": { "description": "The properties for the config choice to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__UpdateConfigChoiceProperties" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__V2ConfigChoice" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updateconfigchoice.md" } }, "/front-office/v1/department/{departmentId}/contact": { "post": { "tags": [ "Departments" ], "summary": "Create a Contact For Department", "description": "Creates a contact for the specified company department.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a contact for the specified company department.\n\nSource reference: https://developer.avionte.com/reference/createcontact.md", "operationId": "CreateContact", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "departmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactDTO" } } }, "required": true }, "responses": { "201": { "description": "The created contact.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Contact" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createcontact.md" } }, "/front-office/v1/contact/{contactId}/activity": { "post": { "tags": [ "Contacts" ], "summary": "Create Contact Activity", "description": "Adds an activity relating to the contact. The added activity is displayed on the *Activities* tab of the contact profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds an activity relating to the contact. The added activity is displayed on the *Activities* tab of the contact profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/createcontactactivity.md", "operationId": "CreateContactActivity", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactActivity" } } }, "required": true }, "responses": { "200": { "description": "The contact activity that was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ContactActivity" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createcontactactivity.md" } }, "/front-office/v1/department/address": { "post": { "tags": [ "Departments" ], "summary": "Create a Department Address", "description": "Adds a department address to the *Contacts* tab of the company profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a department address to the *Contacts* tab of the company profile page.\n\n> ⚠️\n>\n> Although the **addressId** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/createdepartmentaddress.md", "operationId": "CreateDepartmentAddress", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DepartmentAddressCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "The created department address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__IntegerSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createdepartmentaddress.md" } }, "/bo-prod/v3/{entityType}/{entityId}/extras": { "post": { "tags": [ "Extra Value (Custom Field)" ], "summary": "Create Extra Value by Entity Type and ID", "description": "Creates an extra value (custom field) by Entity Type and ID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-02T19:20:34.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates an extra value (custom field) by Entity Type and ID.\n\nSource reference: https://developer.avionte.com/reference/createextravaluebyentitytypeandid.md", "operationId": "CreateExtraValueByEntityTypeAndId", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "entityType", "in": "path", "description": "The Back Office entity type.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "Talent" }, { "name": "entityId", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__BackOfficeIdentifierId" }, "example": 29305 } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__CreateExtraValueRequestBody" }, "responses": { "200": { "$ref": "#/components/responses/bo_prod__ExtraValuePostResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "409": { "$ref": "#/components/responses/bo_prod__apiResultDuplicate409" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "ExtraValueController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createextravaluebyentitytypeandid.md" }, "get": { "tags": [ "Extra Value (Custom Field)" ], "summary": "Get Extra Values by Entity Type and ID", "description": "Returns the extra values (custom fields) for a given entity by Entity Type and ID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-02T19:20:34.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the extra values (custom fields) for a given entity by Entity Type and ID.\n\nSource reference: https://developer.avionte.com/reference/getextravaluebyentitytypeandid.md", "operationId": "GetExtraValueByEntityTypeAndId", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "entityType", "in": "path", "description": "The Back Office entity type.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "Talent" }, { "name": "entityId", "in": "path", "description": "The identifier for the entity.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__BackOfficeIdentifierId" }, "example": 29305 } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__ExtraValueGetResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "ExtraValueController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getextravaluebyentitytypeandid.md" } }, "/front-office/v1/user": { "post": { "tags": [ "Users" ], "summary": "Create an HCM User", "description": "Creates an HCM User record that will allow a user to be able to log into Bold.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates an HCM User record that will allow a user to be able to log into Bold.\n\n\n\n
\n\nSource reference: https://developer.avionte.com/reference/createhcmuser.md", "operationId": "CreateHCMUser", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__HcmUser" } } }, "required": true }, "responses": { "201": { "description": "The HCM User that was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ApiUser" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createhcmuser.md" } }, "/back-office/v2/mapping/MappingTypeData": { "post": { "tags": [ "Mapping" ], "operationId": "CreateMappingTypeData", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__MappingTypeDataRequest" } } }, "required": true }, "responses": { "201": { "description": "201 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__MappingTypeData" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "summary": "/v2/mapping/MappingTypeData", "description": "Additional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nSource reference: https://developer.avionte.com/reference/createmappingtypedata.md", "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createmappingtypedata.md" } }, "/front-office/v1/talent/{talentId}/partner-task": { "post": { "tags": [ "Talent" ], "summary": "Create Partner Task", "description": "Creates a partner task on the specified talent on behalf of a partner.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-08-05T19:11:09.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a partner task on the specified talent on behalf of a partner.\n\nSource reference: https://developer.avionte.com/reference/createpartnertaskfortalent.md", "operationId": "CreatePartnerTaskForTalent", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier of the talent to assign the partner task to.", "required": true, "schema": { "type": "string" }, "example": "17847" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PartnerTaskRequest" } } }, "required": true }, "responses": { "201": { "description": "The newly created partner task.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PartnerTaskResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createpartnertaskfortalent.md" } }, "/front-office/v1/talent": { "post": { "tags": [ "Talent" ], "summary": "Create a Talent", "description": "Creates a new talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a new talent record.\n\n\n\n
\n\n\n Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\n\n\n If **useNewTalentRequirements** is set to `true` or omitted, the endpoint will follow the New Talent Requirements configured in BOLD, in addition to its default required fields.\n\n If **useNewTalentRequirements** is set to `false`, the endpoint will ignore the New Talent Requirements in BOLD and will only require **FirstName**, **LastName**, and **Email** in the payload, along with its default required fields.\n\n\n> 📘 StatusId and Status\n>\n> Either a valid **StatusId** or **Status** value is required to be passed in the payload.\n>\n> If both a valid **StatusId** and a **Status** value are passed in the payload, the endpoint will set the talent status using the provided **StatusId**.\n>\n> If only a valid **Status** value is passed in the payload, the endpoint will set the talent status using the provided **Status** value.\n>\n> * If the tenant has an existing status configured in Table Editor, that matches with the **Status** value in the payload, the endpoint will use that value to set the talent's status. Otherwise, the endpoint will create a new status in the Table Editor and will set the talent's status to that newly created status.\n\nSource reference: https://developer.avionte.com/reference/createtalent.md", "operationId": "CreateTalent", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "useNewTalentRequirements", "in": "query", "description": "An indication of whether new talent requirements from BOLD should be used when creating a new talent.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Details of new talent to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentDto" } } }, "required": true }, "responses": { "201": { "description": "The created talent record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Talent" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtalent.md" } }, "/bo-prod/v3/talent/accrual-manual-entries": { "post": { "tags": [ "Accrual" ], "summary": "Create Talent Accrual Plan Manual Entry", "description": "Creates a manual entry for the specified accrual plan and talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:39:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a manual entry for the specified accrual plan and talent.\n\nSource reference: https://developer.avionte.com/reference/createtalentaccrualplanmanualentry.md", "operationId": "CreateTalentAccrualPlanManualEntry", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 }, { "name": "configAccrualPlanGuid", "in": "query", "description": "The unique identifier for the accrual plan record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, { "name": "AllowNonCurrentEffectiveDate", "in": "query", "description": "An indication of whether the user has approved an effective date that falls outside the current accrual period.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" }, "example": false } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__TalentAccrualPlanManualEntryPostBody" }, "responses": { "200": { "description": "The provided EffectiveDate is not within the current accrual period.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example 1": { "value": { "message": "The provided EffectiveDate is not within the current accrual period.", "currentAccrualPeriod": { "startDate": "2026-01-01", "endDate": "2026-12-31" } } } } } } }, "201": { "description": "Successfully created talent accrual manual entry record.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example 1": { "value": { "talentAccrualGuid": "c4e5d6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f", "accruedUnit": 8, "effectiveDate": "2026-06-15T00:00:00", "excludeFromLimitCalculation": false, "note": "Manual PTO adjustment for approved leave." } } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentAccrualController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtalentaccrualplanmanualentry.md" } }, "/front-office/v1/talent/{talentId}/activity": { "post": { "tags": [ "Talent" ], "summary": "Create a Talent Activity", "description": "Adds a talent activity record for the specified talent. The added activity is displayed on the *Activities* tab of the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a talent activity record for the specified talent. The added activity is displayed on the *Activities* tab of the talent profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/createtalentactivity.md", "operationId": "CreateTalentActivity", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "An identifier for the talent whose activity is being added.", "required": true, "schema": { "type": "string" }, "example": "17484" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentActivity" } } }, "required": true }, "responses": { "200": { "description": "The created talent activity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentActivity" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtalentactivity.md" } }, "/bo-prod/v3/talent/create-default-tax": { "post": { "tags": [ "Taxes" ], "summary": "Create Talent Default Taxes", "description": "Creates the default taxes for the specified talent record based on the talent's resident address and the worksite addresses of their placements.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-15T13:07:48.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates the default taxes for the specified talent record based on the talent's resident address and the worksite addresses of their placements.\n\nSource reference: https://developer.avionte.com/reference/createtalentdefaulttaxes.md", "operationId": "CreateTalentDefaultTaxes", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentTaxDetailResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "409": { "$ref": "#/components/responses/bo_prod__apiResultDuplicate409" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtalentdefaulttaxes.md" } }, "/front-office/v1/talent/{talentId}/job-activity": { "post": { "tags": [ "Talent" ], "summary": "Create a Talent Job Activity", "description": "Adds a job activity relating to the talent. The added activity is displayed on the *Activities* tab of the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds a job activity relating to the talent. The added activity is displayed on the *Activities* tab of the talent profile page.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/createtalentjobactivity.md", "operationId": "CreateTalentJobActivity", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record to which the activity should be added.", "required": true, "schema": { "type": "string" }, "example": "184748" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentJobActivity" } } }, "required": true }, "responses": { "201": { "description": "The created talent job activity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentJobActivity" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtalentjobactivity.md" } }, "/front-office/v1/talent/{talentId}/resume-tags": { "post": { "tags": [ "Talent" ], "summary": "Add Talent Resume Tags", "description": "Adds talent resume skills and their corresponding skills rating values.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds talent resume skills and their corresponding skills rating values.\n\nSource reference: https://developer.avionte.com/reference/createtalentresumetags.md", "operationId": "CreateTalentResumeTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent.", "required": true, "schema": { "type": "integer" }, "example": "1788427" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentResumeSkill" } } }, "required": true }, "responses": { "201": { "description": "A list of all talent resume tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentResumeSkillsResponse" }, "example": { "talentId": 1788427, "talentResumeSkills": [ { "id": 1848945, "name": "Java", "value": 5 }, { "id": 1674824, "name": "C#", "value": 4 }, { "id": 1485992, "name": "SQL", "value": 3 } ] } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtalentresumetags.md" }, "get": { "tags": [ "Talent" ], "summary": "Get Talent Resume Tags", "description": "Returns talent resume skills and their corresponding skills rating values from the _Tags_ tab for the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns talent resume skills and their corresponding skills rating values from the _Tags_ tab for the specified talent record.\n\nSource reference: https://developer.avionte.com/reference/gettalentresumetags.md", "operationId": "GetTalentResumeTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent.", "required": true, "schema": { "type": "integer" }, "example": "1788427" } ], "responses": { "200": { "description": "Detailed talent resume skills information for the specified talent, including the talent identifier and associated skills with rating values from the Tags tab.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentResumeSkillsResponse" }, "example": { "talentId": 1788427, "talentResumeSkills": [ { "id": 1848945, "name": "Java", "value": 5 }, { "id": 1674824, "name": "C#", "value": 4 }, { "id": 1485992, "name": "SQL", "value": 3 } ] } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentresumetags.md" } }, "/bo-prod/v3/talent/tax-county": { "post": { "tags": [ "Taxes" ], "summary": "Create Talent Tax County Record", "description": "Creates a new tax county record for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:41:23.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a new tax county record for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/createtalenttaxcounty.md", "operationId": "CreateTalentTaxCounty", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__CreateTaxCountyRequestBody" }, "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentTaxCountyResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "409": { "$ref": "#/components/responses/bo_prod__apiResultDuplicate409" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtalenttaxcounty.md" }, "get": { "tags": [ "Taxes" ], "summary": "Get Talent Tax County", "description": "Returns the county setup for Indiana withholding.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:41:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the county setup for Indiana withholding.\n\nSource reference: https://developer.avionte.com/reference/gettalenttaxcounty.md", "operationId": "GetTalentTaxCounty", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 }, { "name": "year", "in": "query", "description": "A general-use integer value representing a year.", "schema": { "type": "integer" }, "example": 2026 } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentTaxCountyResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalenttaxcounty.md" }, "patch": { "tags": [ "Taxes" ], "summary": "Update Talent Tax County Record", "description": "Updates a new tax county record for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:41:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates a new tax county record for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/updatetalenttaxcounty.md", "operationId": "UpdateTalentTaxCounty", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 }, { "name": "employeeTaxCountyId", "in": "query", "description": "The unique identifier for the talent tax county data.", "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32" }, "example": 42 } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ArrayOfPatchOperations" }, "examples": { "Example 1": { "value": [ { "op": "replace", "path": "/residentCountyGeocode", "value": "27053" }, { "op": "replace", "path": "/worksiteCountyGeocode", "value": "27053" } ] } } } } }, "responses": { "200": { "description": "Record modified successfully." }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatetalenttaxcounty.md" } }, "/front-office/v1/user/talent-user": { "post": { "tags": [ "Users" ], "summary": "Create a Talent User", "description": "Creates a Talent User record that will allow a talent to be able to log into Bold.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a Talent User record that will allow a talent to be able to log into Bold.\n\nSource reference: https://developer.avionte.com/reference/createtalentuser.md", "operationId": "CreateTalentUser", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentUserRequest" } } }, "required": true }, "responses": { "201": { "description": "The Talent User that was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentUser" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtalentuser.md" } }, "/front-office/v1/talent/{talentId}/work-history": { "post": { "tags": [ "Talent" ], "summary": "Create a Talent Work History", "description": "Adds details about the talent’s previous work experience. This information is displayed on the *Work History* tab of the talent profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds details about the talent’s previous work experience. This information is displayed on the *Work History* tab of the talent profile.\n\n> ⚠️\n>\n> Although the **workHistoryID** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/createtalentworkhistory.md", "operationId": "CreateTalentWorkHistory", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent for whom the work history record is being created.", "required": true, "schema": { "type": "string" }, "example": "189948" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentWorkHistory" } } }, "required": true }, "responses": { "201": { "description": "The work history for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentWorkHistory" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtalentworkhistory.md" }, "get": { "tags": [ "Talent" ], "summary": "Get Talent Work History", "description": "Returns details about the talent’s work experience from the *Work History* tab of the talent’s profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the talent’s work experience from the *Work History* tab of the talent’s profile.\n\nSource reference: https://developer.avionte.com/reference/gettalentworkhistory.md", "operationId": "GetTalentWorkHistory", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose work history is being retrieved.", "required": true, "schema": { "type": "string" }, "example": "189494" } ], "responses": { "200": { "description": "The work history for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentWorkHistory" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentworkhistory.md" } }, "/front-office/v1/timesheets": { "post": { "tags": [ "Timesheets" ], "summary": "Create TimeSheet", "description": "Creates a new TimeSheet.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a new TimeSheet.\n\nSource reference: https://developer.avionte.com/reference/createtimesheet.md", "operationId": "CreateTimeSheet", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TimeSheetDto" } } }, "required": true }, "responses": { "201": { "description": "The created TimeSheet.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TimeSheetDto" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createtimesheet.md" } }, "/front-office/v1/webapplicants": { "post": { "tags": [ "Web Applicants" ], "summary": "Create a Web Applicant", "description": "Creates a web application for a talent and a job.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a web application for a talent and a job.\n\n\n\n
\n\nSource reference: https://developer.avionte.com/reference/createwebapplicant.md", "operationId": "CreateWebApplicant", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__NewWebApplicant" } } }, "required": true }, "responses": { "201": { "description": "The created web applicant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ApiWebApplicants" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/createwebapplicant.md" } }, "/back-office/v1/time-entry-transaction/{transactionGuid}/item/{transactionTypeId}": { "delete": { "tags": [ "TransactionEntryItem" ], "summary": "Delete Transaction Entry Item", "description": "Deletes a Transaction Entry Item.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nDeletes a Transaction Entry Item.\n\nSource reference: https://developer.avionte.com/reference/deletetransactionentryitem.md", "operationId": "DeleteTransactionEntryItem", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "transactionGuid", "in": "path", "description": "The unique identifier for the pay or bill transaction, formatted as a UUID.", "required": true, "style": "simple", "schema": { "type": "string" }, "x-nullable": false }, { "name": "transactionTypeId", "in": "path", "description": "The type of transaction item to scope request to.", "required": true, "style": "simple", "schema": { "type": "string" }, "x-nullable": false } ], "responses": { "200": { "description": "200 (success)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TimeEntryTransactionItem" } } }, "x-nullable": false }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Access Denied" }, "404": { "description": "Not Found" }, "406": { "description": "Unsupported format(s) indicated by Accept header" }, "415": { "description": "Unsupported format(s) indicated by the Content-Type header" }, "429": { "description": "Too many requests" }, "500": { "description": "An unexpected error occurred" }, "502": { "description": "The request could not be completed because an error occurred in an upstream service" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/deletetransactionentryitem.md" }, "get": { "tags": [ "TransactionEntryItem" ], "summary": "Get Transaction Entry Item", "description": "Returns all payment items for the requested transaction.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns all payment items for the requested transaction.\n\nSource reference: https://developer.avionte.com/reference/gettransactionentryitem.md", "operationId": "GetTransactionEntryItem", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "transactionGuid", "in": "path", "description": "The unique identifier for the pay or bill transaction, formatted as a UUID.", "required": true, "style": "simple", "schema": { "type": "string" }, "x-nullable": false }, { "name": "transactionTypeId", "in": "path", "description": "The type of transaction item to scope request to.", "required": true, "style": "simple", "schema": { "type": "string" }, "x-nullable": false } ], "responses": { "200": { "description": "200 (success)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TimeEntryTransactionItem" } } }, "x-nullable": false }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Access Denied" }, "404": { "description": "Not Found" }, "406": { "description": "Unsupported format(s) indicated by Accept header" }, "415": { "description": "Unsupported format(s) indicated by the Content-Type header" }, "429": { "description": "Too many requests" }, "500": { "description": "An unexpected error occurred" }, "502": { "description": "The request could not be completed because an error occurred in an upstream service" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettransactionentryitem.md" }, "patch": { "tags": [ "TransactionEntryItem" ], "summary": "Patch Transaction Entry Item", "description": "Updates a Transaction Entry Item.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates a Transaction Entry Item.\n\nSource reference: https://developer.avionte.com/reference/patchtransactionentryitem.md", "operationId": "PatchTransactionEntryItem", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "transactionGuid", "in": "path", "description": "The unique identifier for the pay or bill transaction, formatted as a UUID.", "required": true, "style": "simple", "schema": { "type": "string" }, "x-nullable": false }, { "name": "transactionTypeId", "in": "path", "description": "The type of transaction item to scope request to.", "required": true, "style": "simple", "schema": { "type": "string" }, "x-nullable": false } ], "responses": { "200": { "description": "200 (success)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TimeEntryTransactionItem" } } }, "x-nullable": false }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Access Denied" }, "404": { "description": "Not Found" }, "406": { "description": "Unsupported format(s) indicated by Accept header" }, "415": { "description": "Unsupported format(s) indicated by the Content-Type header" }, "429": { "description": "Too many requests" }, "500": { "description": "An unexpected error occurred" }, "502": { "description": "The request could not be completed because an error occurred in an upstream service" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/patchtransactionentryitem.md" }, "post": { "tags": [ "TransactionEntryItem" ], "summary": "Post Transaction Entry Item", "description": "Creates a Transaction Entry Item.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a Transaction Entry Item.\n\nSource reference: https://developer.avionte.com/reference/posttransactionentryitem.md", "operationId": "PostTransactionEntryItem", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "transactionGuid", "in": "path", "description": "The unique identifier for the pay or bill transaction, formatted as a UUID.", "required": true, "style": "simple", "schema": { "type": "string" }, "x-nullable": false }, { "name": "transactionTypeId", "in": "path", "description": "The type of transaction item to scope request to.", "required": true, "style": "simple", "schema": { "type": "string" }, "x-nullable": false } ], "responses": { "200": { "description": "200 (success)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TimeEntryTransactionItem" } } }, "x-nullable": false }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Access Denied" }, "404": { "description": "Not Found" }, "406": { "description": "Unsupported format(s) indicated by Accept header" }, "415": { "description": "Unsupported format(s) indicated by the Content-Type header" }, "429": { "description": "Too many requests" }, "500": { "description": "An unexpected error occurred" }, "502": { "description": "The request could not be completed because an error occurred in an upstream service" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/posttransactionentryitem.md" } }, "/front-office/v1/user/user-type/{userType}/{entityId}": { "get": { "tags": [ "Users" ], "summary": "Get User ID by User Type and Entity Id", "description": "Returns a user ID, for the specified user type and entity Id, registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a user ID, for the specified user type and entity Id, registered in the system.\n\nSource reference: https://developer.avionte.com/reference/entityusertype.md", "operationId": "EntityUserType", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "userType", "in": "path", "description": "The name of the user type. Available options are Talent, Manager, HCM.", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The user ID for the specified user type and entity ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__EntityTypeUserDto" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/entityusertype.md" } }, "/front-office/v1/talent/{talentId}/all-tags": { "get": { "tags": [ "Talent" ], "summary": "Get All Talent Tags", "description": "This endpoint is deprecated. Please use the 'Get a list of Tags for a Talent' endpoint, which also returns a list of all tags for a talent, but respects custom tag category definitions for a client.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nThis endpoint is deprecated. Please use the 'Get a list of Tags for a Talent' endpoint, which also returns a list of all tags for a talent, but respects custom tag category definitions for a client.\n\nSource reference: https://developer.avionte.com/reference/get-all-talent-tags.md", "operationId": "GetAllTalentTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose tags should be retrieved.", "required": true, "schema": { "type": "string" }, "example": "137914" } ], "responses": { "200": { "description": "A list of all tags for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentAllTags" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-all-talent-tags.md", "x-original-operationId": "Get All Talent Tags" } }, "/front-office/v1/company-restrictions/multi-query": { "post": { "tags": [ "Companies" ], "summary": "Get Company Restrictions by Company IDs", "description": "Returns details about all talents who are blocked from placement at the specified company.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about all talents who are blocked from placement at the specified company.\n\nSource reference: https://developer.avionte.com/reference/get-company-restrictions-by-companyids.md", "operationId": "GetCompanyRestrictionsByCompanyIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of company IDs for which to retrieve the restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 12345, 67890 ] } }, "required": true }, "responses": { "200": { "description": "A list of company restrictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCompanyRestriction" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-company-restrictions-by-companyids.md", "x-original-operationId": "Get Company Restrictions By CompanyIds" } }, "/front-office/v1/company-restrictions/talent/{talentId}": { "get": { "tags": [ "Companies" ], "summary": "Get Company Restrictions by Talent ID", "description": "Returns a list of companies where the specified talent is blocked from placement.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of companies where the specified talent is blocked from placement.\n\nSource reference: https://developer.avionte.com/reference/get-company-restrictions-by-talentid.md", "operationId": "GetCompanyRestrictionsByTalentId", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose company restrictions are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "132425" } ], "responses": { "200": { "description": "The list of companies where the specified talent is blocked from placement.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCompanyRestriction" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-company-restrictions-by-talentid.md", "x-original-operationId": "Get Company Restrictions By TalentId" } }, "/front-office/v1/company-restrictions/multi-talents/multi-query": { "post": { "tags": [ "Companies" ], "summary": "Get Company Restrictions by Talent IDs", "description": "Returns a list of companies where the specified talents are blocked from placement.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of companies where the specified talents are blocked from placement.\n\nSource reference: https://developer.avionte.com/reference/get-company-restrictions-by-talentids.md", "operationId": "GetCompanyRestrictionsByTalentIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of talent IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 123, 456, 789 ] } }, "required": true }, "responses": { "200": { "description": "The list of companies where the specified talents are blocked from placement.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCompanyRestriction" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-company-restrictions-by-talentids.md", "x-original-operationId": "Get Company Restrictions By TalentIds" } }, "/front-office/v1/companies/contacts/ids": { "post": { "tags": [ "Companies" ], "summary": "Get Contact IDs for Companies", "description": "Returns a list of contact IDs for the specified companies.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of contact IDs for the specified companies.\n\nSource reference: https://developer.avionte.com/reference/get-contactids-for-companies.md", "operationId": "GetContactIDsForCompanies", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of company IDs for which contact IDs are being requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 12424, 12425 ] } }, "required": true }, "responses": { "200": { "description": "The list of contacts for the specified companies.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCompanyContacts" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-contactids-for-companies.md", "x-original-operationId": "Get ContactIDs For Companies" } }, "/front-office/v1/job/customDetailDefinitions": { "get": { "tags": [ "Jobs" ], "summary": "Get Custom Job Detail Definitions for a Tenant", "description": "Returns a list of Custom Details for the Tenant.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of Custom Details for the Tenant.\n\nSource reference: https://developer.avionte.com/reference/get-custom-job-detail-definitions-for-tenant.md", "operationId": "GetCustomJobDetailDefinitionsForTenant", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of Custom Job Detail Definitions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCustomJobDetailsDefinition" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-custom-job-detail-definitions-for-tenant.md", "x-original-operationId": "Get Custom Job Detail Definitions For Tenant" } }, "/front-office/v1/departments/default-contacts": { "post": { "tags": [ "Departments" ], "summary": "Get Default Contacts", "description": "Returns a Dictionary with company branch IDs as keys and default contact IDs as values. Also returns a list of company branch IDs that were not found\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a Dictionary with company branch IDs as keys and default contact IDs as values. Also returns a list of company branch IDs that were not found\n\nSource reference: https://developer.avionte.com/reference/get-default-contacts.md", "operationId": "GetDefaultContacts", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "The default contacts for the specified company branches.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DepartmentDefaultContactsDictionary" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-default-contacts.md", "x-original-operationId": "Get Default Contacts" } }, "/front-office/v1/departments/default-timesheet-approvers": { "post": { "tags": [ "Departments" ], "summary": "Get Default Timesheet Approvers", "description": "Returns a Dictionary> called branch_default_timesheet_approvers, where branch_IDs are keys, and a List is the value. Also returns a List nonexistent_branches. An empty List means the branch may exist, but default timesheet approvers were not set.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a Dictionary> called branch_default_timesheet_approvers, where branch_IDs are keys, and a List is the value. Also returns a List nonexistent_branches. An empty List means the branch may exist, but default timesheet approvers were not set.\n\n> ⚠️\n>\n> The payload requires a list of Department IDs.\n\nSource reference: https://developer.avionte.com/reference/get-default-timsheet-approvers.md", "operationId": "GetDefaultTimsheetApprovers", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A dictionary mapping branch IDs to their default timesheet approvers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DepartmentDefaultTimesheetApproversDictionary" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-default-timsheet-approvers.md", "x-original-operationId": "Get Default Timsheet Approvers" } }, "/front-office/v1/departments/ids/{page}/{pageSize}": { "get": { "tags": [ "Departments" ], "summary": "Get Department IDs", "description": "Returns a paged list of all department IDs registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of all department IDs registered in the system.\n\nSource reference: https://developer.avionte.com/reference/get-department-ids.md", "operationId": "GetDepartmentIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A list of department IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-department-ids.md", "x-original-operationId": "Get Department Ids" } }, "/front-office/v1/companies/departments/ids": { "post": { "tags": [ "Companies" ], "summary": "Get Department IDs for Companies", "description": "Returns a list of department IDs for the specified companies.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of department IDs for the specified companies.\n\nSource reference: https://developer.avionte.com/reference/get-departmentids-for-companies.md", "operationId": "GetDepartmentIdsForCompanies", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of company IDs for which department IDs are being retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 21843, 21844, 21845 ] } }, "required": true }, "responses": { "200": { "description": "A list of department IDs for the specified companies.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-departmentids-for-companies.md", "x-original-operationId": "Get DepartmentIds For Companies" } }, "/front-office/v1/talent/getEEODefinitions": { "get": { "tags": [ "Talent" ], "summary": "Get EEO Definitions", "description": "Returns a list of dropdown values for EEO definitions from the *Tax* tab of the talent profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of dropdown values for EEO definitions from the *Tax* tab of the talent profile.\n\nSource reference: https://developer.avionte.com/reference/get-eeo-definitions.md", "operationId": "GetEEODefinitions", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of EEO definitions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__EEODefinitions" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-eeo-definitions.md", "x-original-operationId": "Get EEO Definitions" } }, "/front-office/v1/job/{jobId}/skills": { "get": { "tags": [ "Jobs" ], "summary": "Get Job Skills", "description": "Returns a list of skills for the specified job.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of skills for the specified job.\n\nSource reference: https://developer.avionte.com/reference/get-job-skills.md", "operationId": "GetJobSkills", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "jobId", "in": "path", "description": "The identifier for the job for which skills are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "1487247" } ], "responses": { "200": { "description": "A list of skills for the specified job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJobSkill" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-job-skills.md", "x-original-operationId": "Get Job Skills" } }, "/front-office/v1/job-status": { "get": { "tags": [ "Jobs" ], "summary": "Get Job Status Definitions", "description": "Returns a list of job statuses that can be assigned to a job.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of job statuses that can be assigned to a job.\n\nSource reference: https://developer.avionte.com/reference/get-job-status.md", "operationId": "Get-Job-Status", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of job status definitions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJobStatusData" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-job-status.md" } }, "/front-office/v1/job-status/{name}": { "get": { "tags": [ "Jobs" ], "summary": "Get Job Status Definition by Name", "description": "Returns a job status by name that can be assigned to a job.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a job status by name that can be assigned to a job.\n\nSource reference: https://developer.avionte.com/reference/get-job-status-by-name.md", "operationId": "Get-Job-Status-By-Name", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "name", "in": "path", "description": "The name of the job status definition to retrieve.", "required": true, "schema": { "type": "string" }, "example": "Open" } ], "responses": { "200": { "description": "The job status definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__JobStatusData" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-job-status-by-name.md" } }, "/front-office/v1/job-types": { "get": { "tags": [ "Jobs" ], "summary": "Get Job Types", "description": "Returns a list of available job types.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of available job types.\n\nSource reference: https://developer.avionte.com/reference/get-jobtypes.md", "operationId": "GetJobTypes", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of job types.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJobType" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-jobtypes.md", "x-original-operationId": "Get JobTypes" } }, "/front-office/v1/new-job-required-fields": { "get": { "tags": [ "Jobs" ], "summary": "Get New Job Required Fields", "description": "Returns a list of required fields for creating a new job.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of required fields for creating a new job.\n\nSource reference: https://developer.avionte.com/reference/get-newjobrequiredfields.md", "operationId": "GetNewJobRequiredFields", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "The list of required fields for creating a new job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__NewJobRequiredFields" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-newjobrequiredfields.md", "x-original-operationId": "Get NewJobRequiredFields" } }, "/front-office/v1/rules/overtime/{otRuleId}": { "get": { "tags": [ "Jobs", "Placements" ], "summary": "Get an Overtime Rule", "description": "Returns details about the specified overtime rule.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified overtime rule.\n\nSource reference: https://developer.avionte.com/reference/get-overtime-rule-by-id.md", "operationId": "GetOvertimeRuleById", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "otRuleId", "in": "path", "description": "The identifier for the Overtime Rule to retrieve.", "required": true, "schema": { "type": "string" }, "example": 583 } ], "responses": { "200": { "description": "The Overtime Rule details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__OTRules" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-overtime-rule-by-id.md", "x-original-operationId": "Get Overtime Rule By Id" } }, "/front-office/v1/rules/overtime": { "get": { "tags": [ "Jobs", "Placements" ], "summary": "Get Overtime Rules", "description": "Returns a list of overtime rules available to assign to a job or placement.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of overtime rules available to assign to a job or placement.\n\nSource reference: https://developer.avionte.com/reference/get-overtime-rules.md", "operationId": "GetOvertimeRules", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of Overtime Rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfOTRules" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-overtime-rules.md", "x-original-operationId": "Get Overtime Rules" } }, "/front-office/v1/skill-positions/{page}/{pageSize}": { "get": { "tags": [ "Talent", "Jobs" ], "summary": "Get Paged Skill Positions", "description": "Returns a paged list of positions and their skills descriptions.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of positions and their skills descriptions.\n\nSource reference: https://developer.avionte.com/reference/get-paged-skillpositions.md", "operationId": "GetPagedSkillPositions", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "description": "The page number to retrieve in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "pageSize", "in": "path", "description": "The number of records to include per page in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "50" } ], "responses": { "200": { "description": "A paged list of skill positions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfSkill" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-paged-skillpositions.md", "x-original-operationId": "Get Paged SkillPositions" } }, "/front-office/v1/job/{jobId}/placements": { "get": { "tags": [ "Jobs" ], "summary": "Get Placements for a Job", "description": "Returns a list of placements and their details for the specified job ID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of placements and their details for the specified job ID.\n\nSource reference: https://developer.avionte.com/reference/get-placements-for-job.md", "operationId": "GetPlacementsForJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "jobId", "in": "path", "description": "The identifier for the job whose placements are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "187424" } ], "responses": { "200": { "description": "A list of placements for the specified job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfPlacement" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-placements-for-job.md", "x-original-operationId": "Get Placements For Job" } }, "/front-office/v1/skill-positions/categories": { "get": { "tags": [ "Talent", "Jobs" ], "summary": "Get Skill Categories", "description": "Returns a list of positions and position IDs available in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of positions and position IDs available in the system.\n\nSource reference: https://developer.avionte.com/reference/get-skill-categories.md", "operationId": "GetSkillCategories", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of skill categories.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfSkillCategory" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-skill-categories.md", "x-original-operationId": "Get Skill Categories" } }, "/front-office/v1/talent/{talentId}/talent-education-history/{talentEducationHistoryId}": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Education History By Education History ID", "description": "Returns details about the specified education experience for the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified education experience for the specified talent record.\n\nSource reference: https://developer.avionte.com/reference/get-talent-education-history-by-education-history-id.md", "operationId": "GetTalentEducationHistoryByEducationHistoryId", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose education history details are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17848" }, { "name": "talentEducationHistoryId", "in": "path", "description": "The identifier for the talent education history record.", "required": true, "schema": { "type": "string" }, "example": "4829" } ], "responses": { "200": { "description": "The specified talent education history record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentEducationHistory" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-talent-education-history-by-education-history-id.md", "x-original-operationId": "Get Talent Education History by Education History Id" }, "put": { "tags": [ "Talent" ], "summary": "Update Talent Education History", "description": "Updates information about the specified education history.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates information about the specified education history.\n\n> ⚠️\n>\n> When making a PUT request, make sure to include the entire object in the payload for successful updates.\n\nSource reference: https://developer.avionte.com/reference/update-talent-education-history.md", "operationId": "UpdateTalentEducationHistory", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose education history record is being updated.", "required": true, "schema": { "type": "string" }, "example": "187482" }, { "name": "talentEducationHistoryId", "in": "path", "description": "The identifier for the talent education history record to be updated.", "required": true, "schema": { "type": "string" }, "example": "4873" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentEducationHistory" } } }, "required": true }, "responses": { "200": { "description": "The updated talent education history record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentEducationHistory" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/update-talent-education-history.md", "x-original-operationId": "Update Talent Education History" } }, "/front-office/v1/job/{jobId}/talent-stages": { "get": { "tags": [ "Jobs" ], "summary": "Get Talent Stages for a Job", "description": "Returns a list of talent records for the specified job and their current status in the nomination stages.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of talent records for the specified job and their current status in the nomination stages.\n\nSource reference: https://developer.avionte.com/reference/get-talent-stages-for-job.md", "operationId": "GetTalentStagesForJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "jobId", "in": "path", "description": "The identifier for the job for which talent stages are being retrieved.", "required": true, "schema": { "type": "string" }, "example": 178484 } ], "responses": { "200": { "description": "A list of talent nomination stage records for the specified job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentStage" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-talent-stages-for-job.md", "x-original-operationId": "Get Talent Stages For Job" } }, "/front-office/v1/talent/{talentId}/work-history/{workHistoryId}": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Work History by Work History ID", "description": "Returns details about the specified work experience for the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified work experience for the specified talent record.\n\nSource reference: https://developer.avionte.com/reference/get-talentworkhistory-by-workhistoryid.md", "operationId": "GetTalentWorkHistoryByWorkHistoryId", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent associated with the work history record.", "required": true, "schema": { "type": "string" }, "example": "17848" }, { "name": "workHistoryId", "in": "path", "description": "The identifier for the talent work history record to retrieve.", "required": true, "schema": { "type": "string" }, "example": "4829" } ], "responses": { "200": { "description": "The requested talent work history record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentWorkHistory" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-talentworkhistory-by-workhistoryid.md", "x-original-operationId": "Get TalentWorkHistory By WorkHistoryId" }, "put": { "tags": [ "Talent" ], "summary": "Update Talent Work History", "description": "Updates the specified work history information for the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the specified work history information for the specified talent record.\n\n> ⚠️\n>\n> When making a PUT request, make sure to include the entire object in the payload for successful updates.\n\nSource reference: https://developer.avionte.com/reference/update-talentworkhistory.md", "operationId": "UpdateTalentWorkHistory", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent associated with the work history record.", "required": true, "schema": { "type": "string" }, "example": "187482" }, { "name": "workHistoryId", "in": "path", "description": "The identifier for the work history record to be updated.", "required": true, "schema": { "type": "string" }, "example": "4873" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentWorkHistory" } } }, "required": true }, "responses": { "200": { "description": "The updated talent work history record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentWorkHistory" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/update-talentworkhistory.md", "x-original-operationId": "Update TalentWorkHistory" } }, "/front-office/v1/webapplicants/job/{jobId}": { "get": { "tags": [ "Web Applicants" ], "summary": "Get Web Applicants for a Job", "description": "Returns a list of web applicants for the specified job ID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of web applicants for the specified job ID.\n\nSource reference: https://developer.avionte.com/reference/get-web-applicants-for-job.md", "operationId": "GetWebApplicantsForJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "jobId", "in": "path", "description": "The identifier for the job whose web applicants are being retrieved.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A list of web applicants for the specified job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfApiWebApplicants" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-web-applicants-for-job.md", "x-original-operationId": "Get Web Applicants For Job" } }, "/front-office/v1/webapplicants/talent/{talentId}": { "get": { "tags": [ "Web Applicants" ], "summary": "Get Web Applications For a Talent", "description": "Returns a list of Job IDs the specified talent has applied for from the web.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of Job IDs the specified talent has applied for from the web.\n\nSource reference: https://developer.avionte.com/reference/get-web-applications-for-talent.md", "operationId": "GetWebApplicationsForTalent", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The list of job IDs the specified talent has applied for.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfApiWebApplicants" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/get-web-applications-for-talent.md", "x-original-operationId": "Get Web Applications For Talent" } }, "/bo-prod/v3/talent/accrual-options/date-types": { "get": { "tags": [ "Accrual" ], "summary": "Get Accrual Plan Date Type Option Items", "description": "Returns the system-level options for accrual date types.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:13:24.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the system-level options for accrual date types.\n\nSource reference: https://developer.avionte.com/reference/getaccrualplandatetypeoptionitems.md", "operationId": "GetAccrualPlanDateTypeOptionItems", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentAccrualPlanDateTypeOptionItemsResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentAccrualOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getaccrualplandatetypeoptionitems.md" } }, "/bo-prod/v3/talent/accrual-options/rate-types": { "get": { "tags": [ "Accrual" ], "summary": "Get Accrual Plan Rate Type Option Items", "description": "Returns the system-level options for accrual rate types.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-14T21:55:52.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the system-level options for accrual rate types.\n\nSource reference: https://developer.avionte.com/reference/getaccrualplanratetypeoptionitems.md", "operationId": "GetAccrualPlanRateTypeOptionItems", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentAccrualPlanRateTypeOptionItemsResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentAccrualOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getaccrualplanratetypeoptionitems.md" } }, "/front-office/v1/placement/active-placements": { "post": { "tags": [ "Placements" ], "summary": "Get Active Placements by Company IDs", "description": "Returns a list of active placements for the specified company IDs.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of active placements for the specified company IDs.\n\nSource reference: https://developer.avionte.com/reference/getactiveplacementsbycompany.md", "operationId": "GetActivePlacementsByCompany", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of company IDs for which active placements are being queried.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 123, 456, 789 ] } }, "required": true }, "responses": { "200": { "description": "A list of active placements for each company ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfPlacement" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getactiveplacementsbycompany.md" } }, "/back-office/v2/mapping/aesop": { "get": { "tags": [ "Mapping" ], "operationId": "GetAesopMappingData", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfMappedData" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "summary": "/v2/mapping/aesop", "description": "Additional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nSource reference: https://developer.avionte.com/reference/getaesopmappingdata.md", "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getaesopmappingdata.md" } }, "/back-office/v2/config-choice/all": { "get": { "tags": [ "ConfigChoice" ], "summary": "Get All Config Choices", "description": "Returns all Config Choices.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns all Config Choices.\n\nSource reference: https://developer.avionte.com/reference/getallconfigchoices.md", "operationId": "GetAllConfigChoices", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfConfigChoice" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getallconfigchoices.md" } }, "/front-office/v1/contact/activity-types": { "get": { "tags": [ "Contacts" ], "summary": "Get All Contact Activity Types", "description": "Returns a list of available activities that can be logged for a contact and their details.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of available activities that can be logged for a contact and their details.\n\nSource reference: https://developer.avionte.com/reference/getallcontactactivitytypes.md", "operationId": "GetAllContactActivityTypes", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of contact activity types.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfActivityType" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getallcontactactivitytypes.md" } }, "/front-office/v1/talent/activity-types": { "get": { "tags": [ "Talent" ], "summary": "Get All Talent Activity Types", "description": "Returns a list of all available activity types that can be logged for a talent, along with their details.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of all available activity types that can be logged for a talent, along with their details.\n\nSource reference: https://developer.avionte.com/reference/getalltalentactivitytypes.md", "operationId": "GetAllTalentActivityTypes", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of all available activity types for a talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfActivityType" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getalltalentactivitytypes.md" } }, "/front-office/v1/applicant-account/{applicantId}": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Accounts", "description": "Returns details about the specified talent account.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified talent account.\n\nSource reference: https://developer.avionte.com/reference/getapplicantaccount.md", "operationId": "GetApplicantAccount", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent whose accounts are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "18374" }, { "name": "includeArchived", "in": "query", "description": "An indication of whether archived accounts are included in the response. When `true`, both active and archived accounts are returned. When `false` (default), only active accounts are returned.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "A list of bank accounts for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfBankAccount" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getapplicantaccount.md" } }, "/front-office/v1/webapplicants/talent/{talentId}/posted-jobs": { "get": { "tags": [ "Web Applicants" ], "summary": "Get Applicant Posted Jobs", "description": "Returns a list of posted jobs that a talent has applied for.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of posted jobs that a talent has applied for.\n\nSource reference: https://developer.avionte.com/reference/getapplicantpostedjobs.md", "operationId": "GetApplicantPostedJobs", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose posted jobs are being retrieved.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The list of jobs that the specified talent has applied for.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentAppliedJobs" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getapplicantpostedjobs.md" } }, "/front-office/v1/talent/{talentId}/talent-profile/profile-image": { "get": { "tags": [ "TalentProfile" ], "summary": "Get Talent Profile Image", "description": "Gets profile image of a the specified talent\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nGets profile image of a the specified talent\n\nSource reference: https://developer.avionte.com/reference/getapplicantprofileimage.md", "operationId": "GetApplicantProfileImage", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "A talentId to retrieve detail about the specified talent record ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The retrieved talent profile image.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ApplicantProfileImageResponseDto" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getapplicantprofileimage.md" }, "put": { "tags": [ "TalentProfile" ], "summary": "Update Talent Profile Image", "description": "Uploads image profile of the specified talent\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUploads image profile of the specified talent\n\nSource reference: https://developer.avionte.com/reference/uploadapplicantprofileimage.md", "operationId": "UploadApplicantProfileImage", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentProfileImageDto" } } }, "required": true }, "responses": { "201": { "description": "Success response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__StringSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/uploadapplicantprofileimage.md" } }, "/front-office/v1/timesheets/{id}": { "get": { "tags": [ "Timesheets" ], "summary": "Get Approved Timesheet", "description": "Returns details about the specified approved timesheet.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified approved timesheet.\n\nSource reference: https://developer.avionte.com/reference/getapprovedtimesheet.md", "operationId": "GetApprovedTimeSheet", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "id", "in": "path", "description": "The identifier for the approved timesheet to be retrieved.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The approved timesheet details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TimeSheet" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getapprovedtimesheet.md" } }, "/front-office/v1/timesheet/approver-terms": { "get": { "tags": [ "Timesheets" ], "summary": "Get Approver Terms", "description": "Returns the account's configured timesheet Approver Terms configured under _Accounts & Settings_ > _Utilities_.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-09-03T17:26:12.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the account's configured timesheet Approver Terms configured under _Accounts & Settings_ > _Utilities_.\n\nSource reference: https://developer.avionte.com/reference/getapproverterms.md", "operationId": "GetApproverTerms", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "The account's configured Approver Terms.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ApproverTerms" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getapproverterms.md" } }, "/front-office/v1/talent-statuses": { "get": { "tags": [ "Talent" ], "summary": "Get Available Talent Statuses", "description": "Returns a list of talent system statuses available in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of talent system statuses available in the system.\n\nSource reference: https://developer.avionte.com/reference/getavailabletalentstatuses.md", "operationId": "GetAvailableTalentStatuses", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "includeDuplicates", "in": "query", "description": "An indication of whether to include duplicate statuses in the response. Accepts True or False.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A list of all talent statuses available in the system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentStatus" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getavailabletalentstatuses.md" } }, "/front-office/v1/talent/{talentId}/background-check": { "get": { "tags": [ "Talent" ], "summary": "Get Background Checks", "description": "Retrieves results of all background checks for a talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves results of all background checks for a talent.\n\nSource reference: https://developer.avionte.com/reference/getbackgroundcheck.md", "operationId": "GetBackgroundCheck", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose background check results are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "184762" } ], "responses": { "200": { "description": "A list of background check results.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfBackgroundCheck" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbackgroundcheck.md" } }, "/bo-prod/v3/billing/option-items/billing-periods": { "get": { "tags": [ "Billing" ], "summary": "Billing Period Options", "description": "Returns a predefined list of billing period values with the valid billing cycles for the period that are supported by the system. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:12:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a predefined list of billing period values with the valid billing cycles for the period that are supported by the system. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.\n\nSource reference: https://developer.avionte.com/reference/getbillingoptionitemsbillingperiods.md", "operationId": "GetBillingOptionItemsBillingPeriods", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "description": "A predefined list of billing period values with the valid billing cycles.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__BillingPeriodOptionArray" }, "examples": { "Example 1": { "value": [ { "billingPeriod": "Weekly", "validBillingCycles": [ "1" ] }, { "billingPeriod": "BiWeekly", "validBillingCycles": [ "1", "2" ] }, { "billingPeriod": "Monthly", "validBillingCycles": [ "1", "2", "3", "4", "LastWeek" ] } ] } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__403AccessDenied" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "BillingOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbillingoptionitemsbillingperiods.md" } }, "/bo-prod/v3/billing/option-items/invoice-display": { "get": { "tags": [ "Billing" ], "summary": "Get Invoice Display Preference Options", "description": "Returns a list of invoice display options configured for a given branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:12:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of invoice display options configured for a given branch.\n\nSource reference: https://developer.avionte.com/reference/getbillingoptionitemsinvoicedisplay.md", "operationId": "GetBillingOptionItemsInvoiceDisplay", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "includeInactive", "in": "query", "description": "An indication of whether to include disabled or inactive statuses in the response. New records cannot be created with an inactive status.", "required": false, "schema": { "type": "string" }, "example": true } ], "responses": { "200": { "description": "A list of invoice display options for the tenant.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__CustomSetupOptionArray" }, "examples": { "Example 1": { "value": [ { "optionId": 1, "optionName": "Hours", "categoryId": 23, "categoryName": "Invoice Display", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [ { "propertyName": "DisplayOrder", "propertyDescription": "The order in which the column is displayed.", "defaultValue": "1", "propertyValue": "1" } ] }, { "optionId": 2, "optionName": "Bill Rate", "categoryId": 23, "categoryName": "Invoice Display", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [] } ] } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "BillingOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbillingoptionitemsinvoicedisplay.md" } }, "/bo-prod/v3/billing/option-items/invoice-grouping": { "get": { "tags": [ "Billing" ], "summary": "Get Invoice Grouping Preference Options", "description": "Returns a list of invoice grouping options configured for a given branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:12:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of invoice grouping options configured for a given branch.\n\nSource reference: https://developer.avionte.com/reference/getbillingoptionitemsinvoicegrouping.md", "operationId": "GetBillingOptionItemsInvoiceGrouping", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "includeInactive", "in": "query", "description": "An indication of whether to include disabled or inactive statuses in the response. New records cannot be created with an inactive status.", "required": false, "schema": { "type": "string" }, "example": true } ], "responses": { "200": { "description": "A list of company statuses for the tenant.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__CustomSetupOptionArray" }, "examples": { "Example 1": { "value": [ { "optionId": 1, "optionName": "Employee", "categoryId": 21, "categoryName": "Invoice Grouping", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [ { "propertyName": "SortOrder", "propertyDescription": "The order in which the grouping is applied.", "defaultValue": "1", "propertyValue": "1" } ] }, { "optionId": 2, "optionName": "Purchase Order", "categoryId": 21, "categoryName": "Invoice Grouping", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [] } ] } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "BillingOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbillingoptionitemsinvoicegrouping.md" } }, "/bo-prod/v3/billing/option-items/invoice-payment-terms": { "get": { "tags": [ "Billing" ], "summary": "Invoice Payment Term Options", "description": "Returns a predefined list of invoice payment terms that are supported by the system. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-14T21:55:52.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a predefined list of invoice payment terms that are supported by the system. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.\n\nSource reference: https://developer.avionte.com/reference/getbillingoptionitemsinvoicepaymentterms.md", "operationId": "GetBillingOptionItemsInvoicePaymentTerms", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "includeInactive", "in": "query", "description": "An indication of whether to include disabled or inactive statuses in the response. New records cannot be created with an inactive status.", "required": false, "schema": { "type": "string" }, "example": true } ], "responses": { "200": { "description": "A predefined list of billing invoice payment terms.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__CustomSetupOptionArray" }, "examples": { "Example 1": { "value": [ { "optionId": 1, "optionName": "Net 30", "categoryId": 12, "categoryName": "Invoice Payment Terms", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [ { "propertyName": "DaysUntilDue", "propertyDescription": "Number of days until the invoice is due.", "defaultValue": "30", "propertyValue": "30" } ] }, { "optionId": 2, "optionName": "Due on Receipt", "categoryId": 12, "categoryName": "Invoice Payment Terms", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [] } ] } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "BillingOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbillingoptionitemsinvoicepaymentterms.md" } }, "/bo-prod/v3/billing/option-items/invoice-separate": { "get": { "tags": [ "Billing" ], "summary": "Get Invoice Separation Preference Options", "description": "Returns a list of invoice separation options configured for a given branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:12:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of invoice separation options configured for a given branch.\n\nSource reference: https://developer.avionte.com/reference/getbillingoptionitemsinvoiceseparating.md", "operationId": "GetBillingOptionItemsInvoiceSeparating", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "includeInactive", "in": "query", "description": "An indication of whether to include disabled or inactive statuses in the response. New records cannot be created with an inactive status.", "required": false, "schema": { "type": "string" }, "example": true } ], "responses": { "200": { "description": "A list of invoice separating options for the tenant.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__CustomSetupOptionArray" }, "examples": { "Example 1": { "value": [ { "optionId": 1, "optionName": "Department", "categoryId": 24, "categoryName": "Invoice Separate", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [ { "propertyName": "SortOrder", "propertyDescription": "The order in which the separation is applied.", "defaultValue": "1", "propertyValue": "1" } ] }, { "optionId": 2, "optionName": "Job Title", "categoryId": 24, "categoryName": "Invoice Separate", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [] } ] } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "BillingOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbillingoptionitemsinvoiceseparating.md" } }, "/bo-prod/v3/billing/option-items/invoice-sort": { "get": { "tags": [ "Billing" ], "summary": "Get Invoice Sorting Preference Options", "description": "Returns a list of invoice sorting options configured for a given branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:12:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of invoice sorting options configured for a given branch.\n\nSource reference: https://developer.avionte.com/reference/getbillingoptionitemsinvoicesorting.md", "operationId": "GetBillingOptionItemsInvoiceSorting", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "includeInactive", "in": "query", "description": "An indication of whether to include disabled or inactive statuses in the response. New records cannot be created with an inactive status.", "required": false, "schema": { "type": "string" }, "example": true } ], "responses": { "200": { "description": "A list of invoice sorting options for the tenant.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__CustomSetupOptionArray" }, "examples": { "Example 1": { "value": [ { "optionId": 1, "optionName": "Employee Name", "categoryId": 22, "categoryName": "Invoice Sort", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [ { "propertyName": "SortOrder", "propertyDescription": "The order in which the sort is applied.", "defaultValue": "1", "propertyValue": "1" } ] }, { "optionId": 2, "optionName": "Date Worked", "categoryId": 22, "categoryName": "Invoice Sort", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [] } ] } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "BillingOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbillingoptionitemsinvoicesorting.md" } }, "/bo-prod/v3/billing/option-items/invoice-style": { "get": { "tags": [ "Billing" ], "summary": "Get Invoice Style Options", "description": "Returns a list of invoice style options configured for a given branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:12:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of invoice style options configured for a given branch.\n\nSource reference: https://developer.avionte.com/reference/getbillingoptionitemsinvoicestyle.md", "operationId": "GetBillingOptionItemsInvoiceStyle", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "includeInactive", "in": "query", "description": "An indication of whether to include disabled or inactive statuses in the response. New records cannot be created with an inactive status.", "required": false, "schema": { "type": "string" }, "example": true } ], "responses": { "200": { "description": "A list of invoice styles for the tenant.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__InvoiceStyleArray" }, "examples": { "Example 1": { "value": [ { "invoiceStyleId": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "invoiceStyleTitle": "Standard", "invoiceStyleDescription": "Standard invoice layout with itemized hours and amounts." }, { "invoiceStyleId": "9c858901-8a57-4791-81fe-4c455b099bc9", "invoiceStyleTitle": "Consolidated", "invoiceStyleDescription": "Consolidated invoice grouping all charges into summary totals." } ] } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "BillingOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbillingoptionitemsinvoicestyle.md" } }, "/front-office/v1/branch/{branchId}": { "get": { "tags": [ "Branches" ], "summary": "Get a Branch", "description": "Returns details about the specified branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified branch.\n\nSource reference: https://developer.avionte.com/reference/getbranch.md", "operationId": "GetBranch", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "branchId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested branch details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Branch" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbranch.md" } }, "/front-office/v1/branch": { "get": { "tags": [ "Branches" ], "summary": "Get Branches", "description": "Returns a list of available branches and their details.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of available branches and their details.\n\nSource reference: https://developer.avionte.com/reference/getbranches.md", "operationId": "GetBranches", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of available branches.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfBranch" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbranches.md" } }, "/back-office/v1/branch": { "get": { "tags": [ "Branch" ], "summary": "Get a List of Branches", "description": "Returns a list of all branches for the specified tenant.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of all branches for the specified tenant.\n\nSource reference: https://developer.avionte.com/reference/getbranches-1.md", "operationId": "GetBranches_3423eb", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "IncludeInactive", "in": "query", "description": "An indication of whether inactive branches should be included in the result. Defaults to false.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfBranch" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getbranches-1.md", "x-original-operationId": "GetBranches" } }, "/front-office/v1/company/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Get a Company", "description": "Returns details about the specified company.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified company.\n\nSource reference: https://developer.avionte.com/reference/getcompany.md", "operationId": "GetCompany", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "An identifier for the company being retrieved.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "The retrieved company record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Company" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompany.md" } }, "/back-office/v2/company/extra/get-by-request": { "post": { "tags": [ "Company" ], "operationId": "GetCompanyExtraByRequest", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__CompanyExtraRequest" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__CompanyTypeExtraValue" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "summary": "/v2/company/extra/get-by-request", "description": "Additional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nSource reference: https://developer.avionte.com/reference/getcompanyextrabyrequest.md", "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanyextrabyrequest.md" } }, "/back-office/v2/company/extra/{value}": { "get": { "tags": [ "Company" ], "operationId": "GetCompanyExtraByValue", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "value", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfCompanyExtraValue" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "summary": "/v2/company/extra/{value}", "description": "Additional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nSource reference: https://developer.avionte.com/reference/getcompanyextrabyvalue.md", "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanyextrabyvalue.md" } }, "/bo-prod/v3/company/hours/detail": { "post": { "tags": [ "Company" ], "summary": "Get Details for Hours Worked", "description": "Returns a list of detail rows for a given set of hours.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:16:07.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of detail rows for a given set of hours.\n\nSource reference: https://developer.avionte.com/reference/getcompanyhoursworkeddetail.md", "operationId": "GetCompanyHoursWorkedDetail", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__arrayOfGuids" }, "responses": { "200": { "$ref": "#/components/responses/bo_prod__HoursHistoryDetailPostResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "409": { "$ref": "#/components/responses/bo_prod__apiResultDuplicate409" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "HoursController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanyhoursworkeddetail.md" } }, "/bo-prod/v3/company/invoice": { "get": { "tags": [ "Invoices" ], "summary": "Get Invoices for a Company", "description": "Returns a list of invoices processed under the company record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T17:13:27.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of invoices processed under the company record.\n\nSource reference: https://developer.avionte.com/reference/getcompanyinvoices.md", "operationId": "GetCompanyInvoices", "parameters": [ { "name": "companyGuid", "in": "query", "description": "The unique identifier for a Company record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22" }, { "name": "companyExternalId", "in": "query", "description": "The external ID of the Company entity, used as an alternative to the __CompanyGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Company entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __CompanyGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 366992 }, { "name": "departmentExternalId", "in": "query", "description": "The unique identifier for a Department record, formatted as a UUID.", "schema": { "type": "string" }, "example": 458434 }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" }, "example": 20 }, { "name": "OpenInvoiceOnly", "in": "query", "description": "An indication of whether to include only invoices with an outstanding balance amount.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": true }, { "name": "SortMethod", "in": "query", "description": "The method used for sorting.", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/bo_prod__SortMethod" }, "example": "Ascending" }, { "name": "SortField", "in": "query", "description": "The field to sort by.", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/bo_prod__InvoiceSortFields" }, "example": "Invoice Number" } ], "responses": { "200": { "description": "A list of company invoices.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__InvoicePage" }, "examples": { "Example 1": { "value": { "totalResults": 1, "pageSize": 25, "currentPage": 1, "totalPages": 1, "currentPageSize": 1, "currentSortMethod": "Ascending", "validSortMethods": [ "Ascending", "Descending" ], "currentInvoiceSortField": "Invoice Number", "validInvoiceSortFields": [ "Invoice Number", "Due Date" ], "result": [ { "invoiceId": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c", "invoiceNumber": "INV-100234", "invoiceDate": "2026-06-15", "billAmount": 5000, "invoiceAmount": 5250, "balanceAmount": 5250, "salesTaxAmount": 250, "discountTaxAmount": 0, "dueDate": "2026-07-15", "branchId": "17343e09-c780-462b-b566-e7258b2054d1", "paymentTermOptionId": 1, "isPosted": true, "billingBatchId": "a1f4c2e8-3b6d-4e9a-8c7f-1d2e3f4a5b6c", "invoiceToId": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22", "invoiceStyleId": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "invoiceTypeOptionId": 1, "totalFinanceChargeAmount": 25 } ] } } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "CompanyInvoiceController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanyinvoices.md" } }, "/bo-prod/v3/company/option-items/statuses": { "get": { "tags": [ "Company" ], "summary": "Get Options for Company Status", "description": "Returns a list of configured options for company status, based on either the Company (for existing records) or the Branch (for new company records). Use the __CompanyGuid__ query parameter if available; otherwise, use __BranchGuid__ for the branch the company will be associated with.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:43:09.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of configured options for company status, based on either the Company (for existing records) or the Branch (for new company records). Use the __CompanyGuid__ query parameter if available; otherwise, use __BranchGuid__ for the branch the company will be associated with.\n\nSource reference: https://developer.avionte.com/reference/getcompanyoptionitemsstatuses.md", "operationId": "GetCompanyOptionItemsStatuses", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "includeInactive", "in": "query", "description": "An indication of whether to include disabled or inactive statuses in the response. New records cannot be created with an inactive status.", "required": false, "schema": { "type": "string" }, "example": true } ], "responses": { "200": { "description": "A list of company statuses for the tenant.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__CustomSetupOptionArray" }, "example": [ { "OptionId": 8, "OptionName": "Prospect", "BranchGuid": "17343E09-C780-462B-B566-E7258B2054D1", "IsDefaultOption": false }, { "OptionId": 33, "OptionName": "Active", "BranchGuid": "17343E09-C780-462B-B566-E7258B2054D1", "IsDefaultOption": true } ] } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "CompanyOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanyoptionitemsstatuses.md" } }, "/front-office/v1/company/purchase-order/{poId}": { "get": { "tags": [ "Companies" ], "summary": "Get Company PO by PO ID", "description": "Returns details about the specified company purchase order.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified company purchase order.\n\nSource reference: https://developer.avionte.com/reference/getcompanypobypoid.md", "operationId": "GetCompanyPoByPoId", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "poId", "in": "path", "description": "The identifier for the purchase order to be retrieved.", "required": true, "schema": { "type": "string" }, "example": "183748" } ], "responses": { "200": { "description": "The company purchase order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyPo" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanypobypoid.md" } }, "/front-office/v1/company-restrictions/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Get Company Restrictions", "description": "Returns details about the talents who are blocked from placement at the specified company.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the talents who are blocked from placement at the specified company.\n\nSource reference: https://developer.avionte.com/reference/getcompanyrestrictions.md", "operationId": "GetCompanyRestrictions", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "The identifier for the company for which restrictions are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "The list of Company Restrictions details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCompanyRestriction" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanyrestrictions.md" } }, "/front-office/v1/company-statuses": { "get": { "tags": [ "Companies" ], "summary": "Get Company Statuses", "description": "Returns a collection of company statuses.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a collection of company statuses.\n\nSource reference: https://developer.avionte.com/reference/getcompanystatuses.md", "operationId": "GetCompanyStatuses", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of company statuses.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCompanyStatusDTO" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanystatuses.md" } }, "/front-office/v1/company-tag-definitions": { "get": { "tags": [ "Companies" ], "summary": "Get Company Tag Definitions", "description": "Returns dropdown values for the tag definitions from the *Tags* tab of the company profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns dropdown values for the tag definitions from the *Tags* tab of the company profile page.\n\nSource reference: https://developer.avionte.com/reference/getcompanytagdefinitions.md", "operationId": "GetCompanyTagDefinitions", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "Company category and source tag definition values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__CompanyTagDefinitions" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanytagdefinitions.md" } }, "/front-office/v1/company/{companyId}/tags": { "get": { "tags": [ "Companies" ], "summary": "Get Company Tags", "description": "Returns a list of company tags from the *Tags* tab for the specified company.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of company tags from the *Tags* tab for the specified company.\n\nSource reference: https://developer.avionte.com/reference/getcompanytags.md", "operationId": "GetCompanyTags", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "companyId", "in": "path", "description": "An identifier for the company whose tags are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17488" } ], "responses": { "200": { "description": "A list of company tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCompanyTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanytags.md" } }, "/front-office/v1/company/tags/multi-query": { "post": { "tags": [ "Companies" ], "summary": "Get the Company Tags by ID List", "description": "Returns a list of company tags from the *Tags* tab for the specified companies.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of company tags from the *Tags* tab for the specified companies.\n\nSource reference: https://developer.avionte.com/reference/getcompanytagsbyidlist.md", "operationId": "GetCompanyTagsByIdList", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of company IDs for which to retrieve tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 42280, 184773, 148722 ] } }, "required": true }, "responses": { "200": { "description": "A list of company tags for the specified companies.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCompanyTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcompanytagsbyidlist.md" } }, "/bo-prod/v3/config-choice/{category}/option-items": { "get": { "tags": [ "Config Choice" ], "summary": "Get Config Choice by Category", "description": "Returns a predefined list of custom setup options from the ConfigChoice table in Back Office.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:14:05.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a predefined list of custom setup options from the ConfigChoice table in Back Office.\n\nSource reference: https://developer.avionte.com/reference/getconfigchoicebycategory.md", "operationId": "GetConfigChoiceByCategory", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "category", "in": "path", "description": "The category value used to retrieve Config Choice records.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "AdjustmentSetup" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__AdminCustomSetupOptionResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "ConfigChoiceController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getconfigchoicebycategory.md" } }, "/back-office/v2/config-choice/{configChoiceId}": { "get": { "tags": [ "ConfigChoice" ], "summary": "Get a Config Choice", "description": "Returns the Config Choice for the specified ID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the Config Choice for the specified ID.\n\nSource reference: https://developer.avionte.com/reference/getconfigchoicebyid.md", "operationId": "GetConfigChoiceById", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "configChoiceId", "in": "path", "description": "The Config Choice ID to search for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__V2ConfigChoice" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getconfigchoicebyid.md" } }, "/back-office/v2/config-choice/by-category/{configChoiceCategoryId}": { "get": { "tags": [ "ConfigChoice" ], "summary": "Get a List of Config Choices by Category ID", "description": "Returns all Config Choices for the specified Config Choice Category ID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns all Config Choices for the specified Config Choice Category ID.\n\nSource reference: https://developer.avionte.com/reference/getconfigchoicesbycategory.md", "operationId": "GetConfigChoicesByCategory", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "configChoiceCategoryId", "in": "path", "description": "The identifier for thw config choice category to search for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfConfigChoice" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getconfigchoicesbycategory.md" } }, "/front-office/v1/contact-activity-definitions/details": { "get": { "tags": [ "Contacts" ], "summary": "Get Contact Activity Details Definitions", "description": "Returns a list of configuration definitions that describe the available contact activity detail types, optionally including archived definitions.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of configuration definitions that describe the available contact activity detail types, optionally including archived definitions.\n\nSource reference: https://developer.avionte.com/reference/getcontactactivitydetailsdefinitions.md", "operationId": "GetContactActivityDetailsDefinitions", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "includeArchived", "in": "query", "description": "An indication of whether archived definitions are included in the results.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "A list of contact activity detail definitions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfContactActivityDetailsDefinition" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcontactactivitydetailsdefinitions.md" } }, "/front-office/v1/contact/tags/multi-query": { "post": { "tags": [ "Contacts" ], "summary": "Get the Contacts Tags by ID List", "description": "Returns a list of contact tags from the *Tags* tab for the specified contacts.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of contact tags from the *Tags* tab for the specified contacts.\n\nSource reference: https://developer.avionte.com/reference/getcontactstagsbyidlist.md", "operationId": "GetContactsTagsByIdList", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of contact IDs for which to retrieve contact tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A list of contact tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfContactTag" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getcontactstagsbyidlist.md" } }, "/front-office/v1/department/{departmentId}": { "get": { "tags": [ "Departments" ], "summary": "Get a Department", "description": "Returns details about the specified department.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified department.\n\nSource reference: https://developer.avionte.com/reference/getdepartment.md", "operationId": "GetDepartment", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "departmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested department record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Department" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getdepartment.md" }, "patch": { "tags": [ "Departments" ], "summary": "Update a Department", "description": "Updates an existing department record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-19T20:06:08.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates an existing department record.\n\nSource reference: https://developer.avionte.com/reference/updatedepartment.md", "operationId": "UpdateDepartment", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "departmentId", "in": "path", "description": "The identifier for the department to update.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "description": "An array of JSON Patch Document operations. Refer to jsonpatch.com for more information.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "description": "The operation to perform. Only 'replace' is supported.", "enum": [ "replace" ] }, "path": { "type": "string", "description": "A JSON Pointer indicating the department field to update.", "enum": [ "/name", "/officeId", "/statusId", "/address/street1", "/address/street2", "/address/city", "/address/state_Province", "/address/postalCode", "/address/country", "/departmentPhone", "/defaultJobOwnerIDs", "/weekendDay", "/payPeriod", "/payCycle", "/billingPeriod", "/billingCycle" ] }, "value": { "description": "The new value to set for the specified path. Valid values for /weekendDay are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. Valid values for /payPeriod and /billingPeriod are: Hourly, Daily, Weekly, BiWeekly, SemiMonthly, Monthly, Yearly. Valid values for /payCycle and /billingCycle are: 1, 2, 3, 4, Last Week. The /address/stateProvince and /address/country fields must be two-character ISO codes." } }, "additionalProperties": false } }, "example": [ { "op": "replace", "path": "/name", "value": "Office" }, { "op": "replace", "path": "/officeId", "value": 67890 }, { "op": "replace", "path": "/statusId", "value": 111 }, { "op": "replace", "path": "/address/street1", "value": "333 3rd St." }, { "op": "replace", "path": "/address/street2", "value": "Suite 100" }, { "op": "replace", "path": "/address/city", "value": "St. Paul" }, { "op": "replace", "path": "/address/state_Province", "value": "MN" }, { "op": "replace", "path": "/address/postalCode", "value": "55101" }, { "op": "replace", "path": "/address/country", "value": "US" }, { "op": "replace", "path": "/departmentPhone", "value": "6511112222" }, { "op": "replace", "path": "/defaultJobOwnerIDs", "value": [ 123456, 789012 ] }, { "op": "replace", "path": "/weekendDay", "value": "Friday" }, { "op": "replace", "path": "/payPeriod", "value": "Weekly" }, { "op": "replace", "path": "/payCycle", "value": "2" }, { "op": "replace", "path": "/billingPeriod", "value": "BiWeekly" }, { "op": "replace", "path": "/billingCycle", "value": "2" } ] } }, "required": true }, "responses": { "200": { "description": "The updated department record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Department" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatedepartment.md" } }, "/front-office/v1/department/address/{addressId}": { "get": { "tags": [ "Departments" ], "summary": "Get a Department Address", "description": "Returns details about the specified department address.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified department address.\n\nSource reference: https://developer.avionte.com/reference/getdepartmentaddress.md", "operationId": "GetDepartmentAddress", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "addressId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The details of the department address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DepartmentAddress" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getdepartmentaddress.md" }, "put": { "tags": [ "Departments" ], "summary": "Update a Department Address", "description": "Updates the address of the specified company department.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the address of the specified company department.\n\n> ⚠️\n>\n> When making a PUT request, make sure to include the entire object in the payload for successful updates.\n\nSource reference: https://developer.avionte.com/reference/updatedepartmentaddress.md", "operationId": "UpdateDepartmentAddress", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "addressId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DepartmentAddressRequest" } } }, "required": true }, "responses": { "200": { "description": "The details of the updated department address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DepartmentAddress" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatedepartmentaddress.md" } }, "/bo-prod/v3/admin/burden-rate-with-factor": { "get": { "tags": [ "Burden" ], "summary": "Burden Rate Setup With Burden Factor", "description": "Returns a predefined list of burden rates setup in the system, with the relevant burden factors applied.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:46:17.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a predefined list of burden rates setup in the system, with the relevant burden factors applied.\n\nSource reference: https://developer.avionte.com/reference/getemployerburdenrateswithburdenfactor.md", "operationId": "GetEmployerBurdenRatesWithBurdenFactor", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "effectiveDate", "in": "query", "description": "A general use datetime value representing a specific point in time, used to compare against a date range. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format, for example, 2026-12-01 or 2026-12-01T14:30:00.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-12-01T14:30:00Z" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__AdminBurdenResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "AdminController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getemployerburdenrateswithburdenfactor.md" } }, "/bo-prod/v3/admin/employer-tax": { "get": { "tags": [ "Taxes" ], "summary": "Employer Tax Setup", "description": "Returns a predefined list of employer taxes setup in the system for the Division of the specified branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:50:36.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a predefined list of employer taxes setup in the system for the Division of the specified branch.\n\nSource reference: https://developer.avionte.com/reference/getemployertaxsetup.md", "operationId": "GetEmployerTaxSetup", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "effectiveDate", "in": "query", "description": "A general use datetime value representing a specific point in time, used to compare against a date range. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format, for example, 2026-12-01 or 2026-12-01T14:30:00.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-12-01T14:30:00Z" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__AdminEmployerTaxResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "AdminController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getemployertaxsetup.md" } }, "/bo-prod/v3/admin/worker-comp": { "get": { "tags": [ "Workers Comp" ], "summary": "Workers Comp Setup", "description": "Returns a predefined list of workers compensation codes setup in the system for the Division of the specified branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:13:59.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a predefined list of workers compensation codes setup in the system for the Division of the specified branch.\n\nSource reference: https://developer.avionte.com/reference/getemployerwccodesetup.md", "operationId": "GetEmployerWcCodeSetup", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "effectiveDate", "in": "query", "description": "A general use datetime value representing a specific point in time, used to compare against a date range. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format, for example, 2026-12-01 or 2026-12-01T14:30:00.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-12-01T14:30:00Z" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__AdminWorkerCompResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "AdminController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getemployerwccodesetup.md" } }, "/front-office/v1/employment-type": { "get": { "tags": [ "Employment Types" ], "summary": "Get Employment Type Definitions", "description": "Returns dropdown values for the employment type definitions from the Tax tab of the talent profile page, that are configured in Table Editor.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns dropdown values for the employment type definitions from the Tax tab of the talent profile page, that are configured in Table Editor.\n\nSource reference: https://developer.avionte.com/reference/getemploymenttype.md", "operationId": "GetEmploymentType", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of employment types.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfReqEmploymentType" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getemploymenttype.md" } }, "/back-office/v2/entity-reference/{entityType}/{idType}/{id}": { "get": { "tags": [ "Reference" ], "summary": "Get Entity Reference by ID", "description": "Returns related BOLD and Back Office entity ID for a variety of entity types.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns related BOLD and Back Office entity ID for a variety of entity types.\n\nSource reference: https://developer.avionte.com/reference/getentityreferenceid.md", "operationId": "GetEntityReferenceId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "entityType", "in": "path", "description": "The entity type to search for. Accepts one of the following values: Employer, Talent, Company, CompanyDepartment, Job, Placement, or ConfigTransactionType.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "idType", "in": "path", "description": "The type of ID to search for. Accepts Bold or BackOffice.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The identifier to search for. If idType is Bold, pass the Bold ID. If it is BackOffice, pass the BackOffice ID. If entityType is Talent, provide either a Talent GUID or a BackOffice ID.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ExternalReference" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getentityreferenceid.md" } }, "/back-office/v2/entity-reference/{entityType}/{idType}": { "post": { "tags": [ "Reference" ], "summary": "Get Entity Reference ID from List", "description": "Returns a list of related BOLD and Back Office entity IDs for a variety of entity types.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of related BOLD and Back Office entity IDs for a variety of entity types.\n\nSource reference: https://developer.avionte.com/reference/getentityreferenceidfromlist.md", "operationId": "GetEntityReferenceIdFromList", "parameters": [ { "name": "entityType", "in": "path", "description": "The entity type to search for. Accepts one of the following values: Employer, Talent, Company, CompanyDepartment, Job, Placement, or ConfigTransactionType.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "idType", "in": "path", "description": "The type of ID to search for. Accepts Bold or BackOffice.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The list of identifiers to search for.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfStringSchema" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfExternalReference" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getentityreferenceidfromlist.md" } }, "/front-office/v1/users": { "get": { "tags": [ "Users" ], "summary": "Get HCM Users", "description": "Returns details about HCM Users registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about HCM Users registered in the system.\n\nSource reference: https://developer.avionte.com/reference/gethcmusers.md", "operationId": "GetHcmUsers", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "The requested user details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfApiUser" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gethcmusers.md" } }, "/front-office/v1/placement/{placementId}": { "get": { "tags": [ "Placements" ], "summary": "Get a Placement", "description": "Returns details about the specified placement.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified placement.\n\nSource reference: https://developer.avionte.com/reference/gethire.md", "operationId": "GetHire", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "placementId", "in": "path", "description": "The unique identifier for the placement to retrieve.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "The placement details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Placement" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gethire.md" }, "put": { "tags": [ "Placements" ], "summary": "Update a Placement", "description": "Updates information about the specified placement.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates information about the specified placement.\n\n> ⚠️\n>\n> When making a PUT request, make sure to include the entire object in the payload for successful updates.\n\nSource reference: https://developer.avionte.com/reference/update-placement.md", "operationId": "UpdatePlacement", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "placementId", "in": "path", "description": "The identifier for the placement that should be updated.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PlacementDto" } } }, "required": true }, "responses": { "200": { "description": "The updated placement details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Placement" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/update-placement.md", "x-original-operationId": "Update Placement" } }, "/front-office/v1/departments/department-address-search": { "get": { "tags": [ "Departments" ], "summary": "Get IDs by department address", "description": "Retrieves a list of address IDs for a department address.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves a list of address IDs for a department address.\n\nSource reference: https://developer.avionte.com/reference/getidsbycompanyaddress.md", "operationId": "GetIdsByCompanyAddress", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DepartmentAddressSearchDTO" } } }, "required": true }, "responses": { "200": { "description": "A list of department address IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getidsbycompanyaddress.md" } }, "/front-office/v1/job/{jobId}": { "get": { "tags": [ "Jobs" ], "summary": "Get a Job", "description": "Returns details about the specified job.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified job.\n\n\n\n
\n\nSource reference: https://developer.avionte.com/reference/getjob.md", "operationId": "GetJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "jobId", "in": "path", "description": "The identifier for the job that is being retrieved.", "required": true, "schema": { "type": "string" }, "example": "1847292" } ], "responses": { "200": { "description": "The requested job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Job" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getjob.md" }, "put": { "tags": [ "Jobs" ], "summary": "Update a Job", "description": "Updates the existing job record in the system\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the existing job record in the system\n\n> ⚠️\n>\n> When making a PUT request, make sure to include the entire object in the payload for successful updates.\n\nSource reference: https://developer.avionte.com/reference/updatejob.md", "operationId": "UpdateJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "jobId", "in": "path", "description": "The identifier for the job that is being updated.", "required": true, "schema": { "type": "string" }, "example": "1847292" }, { "name": "encoding", "in": "query", "description": "The encoding type for the job description.", "required": false, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__JobDto" } } }, "required": true }, "responses": { "200": { "description": "The updated job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Job" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatejob.md" } }, "/front-office/v1/job-activity/types": { "get": { "tags": [ "Jobs" ], "summary": "Get Job Activity Types", "description": "Returns a list of available job activities that can be logged for a talent and their details.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of available job activities that can be logged for a talent and their details.\n\nSource reference: https://developer.avionte.com/reference/getjobactivitytypes.md", "operationId": "GetJobActivityTypes", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of job activity types.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJobActivityType" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getjobactivitytypes.md" } }, "/front-office/v1/job/templates": { "get": { "tags": [ "Jobs" ], "summary": "Get Job Order Templates", "description": "Returns all Job Order Templates for the tenant.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-09-03T17:26:12.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns all Job Order Templates for the tenant.\n\nSource reference: https://developer.avionte.com/reference/getjobordertemplates.md", "operationId": "GetJobOrderTemplates", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of Job Order Templates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJobOrderTemplate" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getjobordertemplates.md" } }, "/front-office/v1/postedJobs/{jobPostingId}": { "get": { "tags": [ "Jobs" ], "summary": "Get a Posted Job", "description": "Returns details about the specified job post.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified job post.\n\nSource reference: https://developer.avionte.com/reference/getjobposting.md", "operationId": "GetJobPosting", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "includeJobDescHtml", "in": "query", "description": "An indication of whether to include the HTML-formatted job description in the response.", "required": false, "schema": { "type": "string" }, "example": "true" }, { "name": "jobPostingId", "in": "path", "description": "The identifier for the job post that is being retrieved.", "required": true, "schema": { "type": "string" }, "example": "1847292" } ], "responses": { "200": { "description": "The requested job post.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__SinglePostedJobResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getjobposting.md" } }, "/front-office/v1/postedJobs": { "post": { "tags": [ "Jobs" ], "summary": "Get Posted Jobs", "description": "Returns a list of posted jobs based on the search criteria posted in the request.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of posted jobs based on the search criteria posted in the request.\n\nSource reference: https://developer.avionte.com/reference/getjobpostings.md", "operationId": "GetJobPostings", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "includeJobDescHtml", "in": "query", "description": "An indication of whether to include the HTML-formatted job description in the response.", "required": false, "schema": { "type": "string" }, "example": "true" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PostedJobRequest" } } }, "required": true }, "responses": { "200": { "description": "A list of posted jobs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PostedJobResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getjobpostings.md" } }, "/back-office/v1/talent/multi-query/job-summary": { "post": { "tags": [ "Talent" ], "summary": "Query Multiple Talent Job Summaries for Current Year", "description": "Retrieves job summary details for talent records, with year-to-date totals calculated based on paycheck data from the current year.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves job summary details for talent records, with year-to-date totals calculated based on paycheck data from the current year.\n\nSource reference: https://developer.avionte.com/reference/getjobsummarymultiquery.md", "operationId": "GetJobSummaryMultiQuery", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "requestBody": { "$ref": "#/components/requestBodies/back_office__multiQueryRequest" }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__MultiQueryResultOfTalentJobSummaryAndGuid" } } } }, "207": { "description": "207 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__MultiQueryResultOfTalentJobSummaryAndGuid" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getjobsummarymultiquery.md" } }, "/back-office/v1/talent/multi-query/job-summary/{paidInYear}": { "post": { "tags": [ "Talent" ], "summary": "Query Job Summary for Multiple Talent", "description": "Retrieves job summary details for talent records, with year-to-date totals calculated based on paycheck data from the specified year (paidInYear). Defaults to the current year if the paidInYear value is not specified.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves job summary details for talent records, with year-to-date totals calculated based on paycheck data from the specified year (paidInYear). Defaults to the current year if the paidInYear value is not specified.\n\nSource reference: https://developer.avionte.com/reference/getjobsummarymultiquerybypaidinyear.md", "operationId": "GetJobSummaryMultiQueryByPaidInYear", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "paidInYear", "in": "path", "description": "The year for which paycheck data is used to calculate year-to-date totals.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/back_office__multiQueryRequest" }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__MultiQueryResultOfTalentJobSummaryAndGuid" } } } }, "207": { "description": "207 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__MultiQueryResultOfTalentJobSummaryAndGuid" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getjobsummarymultiquerybypaidinyear.md" } }, "/front-office/v1/job/matching-jobs": { "post": { "tags": [ "Jobs" ], "summary": "Get Matching Jobs", "description": "Returns a list of jobs from the same branch with the same job title, dates, and rates.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of jobs from the same branch with the same job title, dates, and rates.\n\nSource reference: https://developer.avionte.com/reference/getmatchingjobs.md", "operationId": "GetMatchingJobs", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__JobDto" } } }, "required": true }, "responses": { "200": { "description": "A list of matching jobs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJob" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getmatchingjobs.md" } }, "/front-office/v1/pipeline/multi-query": { "post": { "tags": [ "Talent", "Jobs" ], "summary": "Get Multiple Pipelines By Pipeline IDs", "description": "Returns details about the specified pipelines.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified pipelines.\n\nSource reference: https://developer.avionte.com/reference/getmultiplepipelinebypipelineids.md", "operationId": "GetMultiplePipelineByPipelineIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of pipeline IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A list of talent pipeline details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentPipeline" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getmultiplepipelinebypipelineids.md" } }, "/front-office/v1/company-requirements": { "get": { "tags": [ "Companies" ], "summary": "Get New Company Requirements", "description": "Returns a list of fields required to create a new company record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of fields required to create a new company record.\n\nSource reference: https://developer.avionte.com/reference/getnewcompanyrequirements.md", "operationId": "GetNewCompanyRequirements", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "The list of fields required to create a new company record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__NewCompanyRequirements" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getnewcompanyrequirements.md" } }, "/front-office/v1/talent-requirement": { "get": { "tags": [ "Talent" ], "summary": "Get New Talent Requirements", "description": "Returns a list of fields required to create a new talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of fields required to create a new talent record.\n\nSource reference: https://developer.avionte.com/reference/getnewtalentrequirement.md", "operationId": "GetNewTalentRequirement", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of fields required to create a new talent record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__NewTalentRequirement" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getnewtalentrequirement.md" } }, "/front-office/v1/user/{userId}/office": { "get": { "tags": [ "Users" ], "summary": "Get Office IDs By User ID", "description": "Returns the IDs of the offices to which the specified user has access to.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the IDs of the offices to which the specified user has access to.\n\nSource reference: https://developer.avionte.com/reference/getofficeidsbyuserid.md", "operationId": "GetOfficeIdsByUserId", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A list of office IDs to which the specified user has access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getofficeidsbyuserid.md" } }, "/front-office/v1/talent/{talentId}/onboarding-documents/{documentId}": { "get": { "tags": [ "Talent" ], "summary": "Get a Talent Adobe Onboarding Document", "description": "Retrieves the specified Adobe E-Sign document for a specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves the specified Adobe E-Sign document for a specified talent.\n\nSource reference: https://developer.avionte.com/reference/getonboardingdocument.md", "operationId": "GetOnboardingDocument", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "An identifier for the talent whose onboarding document is being retrieved.", "required": true, "schema": { "type": "string" }, "example": "148922" }, { "name": "documentId", "in": "path", "description": "An identifier for the Adobe E-Sign document that is being retrieved.", "required": true, "schema": { "type": "string" }, "example": "2849284" } ], "responses": { "200": { "description": "The requested Adobe E-Sign document for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__AdobeESignDocument" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getonboardingdocument.md" } }, "/back-office/v1/talent/paid-talent": { "post": { "tags": [ "Talent" ], "summary": "Get Paid Talent", "description": "Returns a paginated list of talent GUIDs with positive total wages within the provided date range.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paginated list of talent GUIDs with positive total wages within the provided date range.\n\nSource reference: https://developer.avionte.com/reference/getpaidtalent.md", "operationId": "GetPaidTalent", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "page", "in": "query", "description": "The page number to retrieve in the paginated response.", "required": false, "schema": { "minimum": 1, "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "The number of items to include per page in the paginated response.", "required": false, "schema": { "maximum": 200, "minimum": 1, "type": "integer" }, "example": 100 } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__PaidTalentSearchParameters" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__PagedResultsOfGuid" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getpaidtalent.md" } }, "/front-office/v1/partner-reference/benefits": { "get": { "tags": [ "Partner References" ], "summary": "Get All Partner Benefit Reference Options", "description": "Returns key-value pairs of all Reference Groups and Reference Options for the tenant. The authenticated API requestor must be a Talent Benefit partner; otherwise, an error is returned.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns key-value pairs of all Reference Groups and Reference Options for the tenant. The authenticated API requestor must be a Talent Benefit partner; otherwise, an error is returned.\n\nSource reference: https://developer.avionte.com/reference/getpartnerbenefitreferenceoptions.md", "operationId": "GetPartnerBenefitReferenceOptions", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of partner benefit reference options.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfBenefitPartnerReference" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getpartnerbenefitreferenceoptions.md" } }, "/back-office/v1/partner-export/{exportBatchId}/{page}/{pageSize}": { "get": { "tags": [ "PartnerExport" ], "summary": "Get Partner Export Batch Paged Data", "description": "After getting a batch ready event, call this endpoint to retrieve a paginated set of batch items for the event's bulk export batch ID. To get all data for a batch, start with page 1 (page size up to 5000) and iterate until last page of data is received.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAfter getting a batch ready event, call this endpoint to retrieve a paginated set of batch items for the event's bulk export batch ID. To get all data for a batch, start with page 1 (page size up to 5000) and iterate until last page of data is received.\n\nSource reference: https://developer.avionte.com/reference/getpartnerexportbatch.md", "operationId": "GetPartnerExportBatch", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "exportBatchId", "in": "path", "description": "The unique identifier for the export batch.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "page", "in": "path", "description": "The page number to retrieve in the paginated response.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "path", "description": "The number of items to include per page in the paginated response.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__BulkDataPage" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getpartnerexportbatch.md" } }, "/front-office/v1/partner-reference/talent-benefits/{talentId}": { "get": { "tags": [ "Partner References" ], "summary": "Get Partner Talent Benefit References", "description": "Returns key-value pairs of all Reference Groups and Reference Options for a specified talent. The authenticated API requestor must be a Talent Benefit partner; otherwise, an error is returned.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns key-value pairs of all Reference Groups and Reference Options for a specified talent. The authenticated API requestor must be a Talent Benefit partner; otherwise, an error is returned.\n\nSource reference: https://developer.avionte.com/reference/getpartnertalentbenefitreferences.md", "operationId": "GetPartnerTalentBenefitReferences", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose benefit partner references are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "184748" } ], "responses": { "200": { "description": "A list of benefit partner references for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfBenefitPartnerReference" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getpartnertalentbenefitreferences.md" } }, "/back-office/v1/transaction-types/partner-benefits": { "get": { "tags": [ "TalentBenefits" ], "summary": "Get Benefit Partner Transaction Types", "description": "Retrieves a list of talent benefit enrollment transaction types for the requesting authorized partner.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves a list of talent benefit enrollment transaction types for the requesting authorized partner.\n\nSource reference: https://developer.avionte.com/reference/getpartnertalentbenefittransactiontypes.md", "operationId": "GetPartnerTalentBenefitTransactionTypes", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentBenefitTransactionType" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getpartnertalentbenefittransactiontypes.md" } }, "/back-office/v1/payment-batch/{paymentBatchGuid}/contributions": { "get": { "tags": [ "Payroll" ], "summary": "Get paycheck contribution by PaymentBatchGuid", "description": "Get list of paycheck contributions by paymentBatchGuid filtered to the authorized partner access.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nGet list of paycheck contributions by paymentBatchGuid filtered to the authorized partner access.\n\nSource reference: https://developer.avionte.com/reference/getpaymentbatchcontributions.md", "operationId": "GetPaymentBatchContributions", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "paymentBatchGuid", "in": "path", "description": "The unique identifier for the payment batch, formatted as a GUID.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfPayrollContribution" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getpaymentbatchcontributions.md" } }, "/back-office/v1/payment-batch/{paymentBatchGuid}/deductions": { "get": { "tags": [ "Payroll" ], "summary": "Get paycheck deduction by PaymentBatchGuid", "description": "Get list of paycheck deductions by paymentBatchGuid filtered to the authorized partner access.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nGet list of paycheck deductions by paymentBatchGuid filtered to the authorized partner access.\n\nSource reference: https://developer.avionte.com/reference/getpaymentbatchdeductions.md", "operationId": "GetPaymentBatchDeductions", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "paymentBatchGuid", "in": "path", "description": "The unique identifier for the payment batch, formatted as a GUID.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfPayrollDeduction" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getpaymentbatchdeductions.md" } }, "/bo-prod/v3/payroll/option-items/payroll-periods": { "get": { "tags": [ "Payroll" ], "summary": "Pay Period Options", "description": "Returns a predefined list of payroll period values supported by the system. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:13:03.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a predefined list of payroll period values supported by the system. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.\n\nSource reference: https://developer.avionte.com/reference/getpayrolloptionitemspayrollperiods.md", "operationId": "GetPayrollOptionItemsPayrollPeriods", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "description": "A predefined list of payroll period values with the valid billing cycles.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ArrayOfPayrollPeriodOptions" }, "example": [ { "PayrollPeriodName": "Weekly", "ValidPayrollCycles": [ 1 ] }, { "PayrollPeriodName": "BiWeekly", "ValidPayrollCycles": [ 1, 2 ] }, { "PayrollPeriodName": "Monthly", "ValidPayrollCycles": [ 1, 2, 3, 4, "LastWeek" ] } ] } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "PayrollOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getpayrolloptionitemspayrollperiods.md" } }, "/back-office/v2/talent/paycheck/{applicantId}/{paymentCheckGuid}/paystub-pdf": { "get": { "tags": [ "Paychecks" ], "summary": "Get Paystub Report by Applicant ID", "description": "Returns a paystub report for the specified paycheck for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paystub report for the specified paycheck for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/getpaystubreportbyapplicantid.md", "operationId": "GetPaystubReportByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "paymentCheckGuid", "in": "path", "description": "The unique identifier for the paycheck, formatted as a GUID.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ByteStringSchema" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getpaystubreportbyapplicantid.md" } }, "/front-office/v1/placement/{placementId}/extension/{extensionId}": { "get": { "tags": [ "Placements" ], "summary": "Get an Extended Placement", "description": "Returns details about the specified placement, with updates from the specified extension.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified placement, with updates from the specified extension.\n\nSource reference: https://developer.avionte.com/reference/getplacement.md", "operationId": "GetPlacement", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "placementId", "in": "path", "description": "The identifier for the placement to be retrieved.", "required": true, "schema": { "type": "string" }, "example": "17837" }, { "name": "extensionId", "in": "path", "description": "The identifier for the extension to be applied to the placement retrieval.", "required": true, "schema": { "type": "string" }, "example": "17837" } ], "responses": { "200": { "description": "The requested placement and extension details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Placement" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getplacement.md" } }, "/front-office/v1/placement/end-reasons": { "get": { "tags": [ "Placements" ], "summary": "Get Placement End Reason Definitions", "description": "Returns a list of dropdown values for the Placement End Reason definitions.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of dropdown values for the Placement End Reason definitions.\n\nSource reference: https://developer.avionte.com/reference/getplacementendreason.md", "operationId": "GetPlacementEndReason", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of placement end reasons.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfEndReason" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getplacementendreason.md" } }, "/back-office/v1/placement/multi-query": { "post": { "tags": [ "Placement" ], "summary": "Get Multiple Placements by Their Placement GUIDs", "description": "Retrieves multiple placement records using their placement GUIDs and returns the associated talent objects or error details.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves multiple placement records using their placement GUIDs and returns the associated talent objects or error details.\n\nSource reference: https://developer.avionte.com/reference/getplacementmultiquery.md", "operationId": "GetPlacementMultiQuery", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "requestBody": { "$ref": "#/components/requestBodies/back_office__multiQueryRequest" }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__MultiQueryResultOfPlacementAndGuid" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getplacementmultiquery.md" } }, "/front-office/v1/skill-positions": { "get": { "tags": [ "Talent", "Jobs" ], "summary": "Get Skill Positions", "description": "Returns a list of available position categories and their details. Position categories are available on the *Tags* tab of the talent profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of available position categories and their details. Position categories are available on the *Tags* tab of the talent profile.\n\nSource reference: https://developer.avionte.com/reference/getskillpositions.md", "operationId": "GetSkillPositions", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of available skill positions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfSkill" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getskillpositions.md" } }, "/front-office/v1/job/standard-job-titles/{standardJobTitleId}": { "get": { "tags": [ "Jobs" ], "summary": "Get Standard Job Title by ID", "description": "Returns details for the specified standard job title configured in the Table Editor, including the associated Standard Occupational Classification (SOC) codes.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details for the specified standard job title configured in the Table Editor, including the associated Standard Occupational Classification (SOC) codes.\n\nSource reference: https://developer.avionte.com/reference/getstandardjobtitle.md", "operationId": "GetStandardJobTitle", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "standardJobTitleId", "in": "path", "description": "The identifier for the Standard Job Title that is to be retrieved.", "required": true, "schema": { "type": "string" }, "example": "1734" } ], "responses": { "200": { "description": "Standard Job Titles details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__JobStandardTitle" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getstandardjobtitle.md" } }, "/front-office/v1/job/standard-job-titles": { "get": { "tags": [ "Jobs" ], "summary": "Get Standard Job Titles", "description": "This endpoint is deprecated. Please use the 'Get paged Standard Job Titles' endpoint.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nThis endpoint is deprecated. Please use the 'Get paged Standard Job Titles' endpoint.\n\nSource reference: https://developer.avionte.com/reference/getstandardjobtitles.md", "operationId": "GetStandardJobTitles", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "410": { "description": "This endpoint is deprecated." }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "deprecated": true, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getstandardjobtitles.md" } }, "/front-office/v1/job/standard-job-titles/paged/{page}/{pageSize}": { "get": { "tags": [ "Jobs" ], "summary": "Get paged Standard Job Titles", "description": "Returns a paged list of standard job titles configured in Table Editor with associated Standard Occupational Classification (SOC) codes.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of standard job titles configured in Table Editor with associated Standard Occupational Classification (SOC) codes.\n\nSource reference: https://developer.avionte.com/reference/getstandardjobtitlespaged.md", "operationId": "GetStandardJobTitlesPaged", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "description": "The page number to retrieve in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "pageSize", "in": "path", "description": "The number of records to include per page in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "50" } ], "responses": { "200": { "description": "A list of Standard Job Titles.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJobStandardTitle" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getstandardjobtitlespaged.md" } }, "/front-office/v1/timesheet/submitter-terms": { "get": { "tags": [ "Timesheets" ], "summary": "Get Submitter Terms", "description": "Returns the account's configured timesheet Submitter Terms configured under _Accounts & Settings_ > _Utilities_.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-09-03T17:26:12.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the account's configured timesheet Submitter Terms configured under _Accounts & Settings_ > _Utilities_.\n\nSource reference: https://developer.avionte.com/reference/getsubmitterterms.md", "operationId": "GetSubmitterTerms", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "The account's configured Submitter Terms.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__SubmitterTerms" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getsubmitterterms.md" } }, "/back-office/v1/supplier/{supplierGuid}": { "get": { "tags": [ "Supplier" ], "summary": "Get a Supplier by UUID", "description": "Returns details for the supplier associated with the specified tenant and supplier UUID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details for the supplier associated with the specified tenant and supplier UUID.\n\nSource reference: https://developer.avionte.com/reference/getsupplierbyguid.md", "operationId": "GetSupplierByGuid", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "supplierGuid", "in": "path", "description": "The unique identifier for the staffing company (supplier), formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__Supplier" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getsupplierbyguid.md" } }, "/back-office/v1/supplier": { "get": { "tags": [ "Supplier" ], "summary": "Get a List of Suppliers", "description": "Returns a list of all Suppliers for the specified Tenant.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of all Suppliers for the specified Tenant.\n\nSource reference: https://developer.avionte.com/reference/getsuppliers.md", "operationId": "GetSuppliers", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfSupplier" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getsuppliers.md" } }, "/front-office/v1/talent/{talentId}/tags": { "get": { "tags": [ "Talent" ], "summary": "Get a List of Tags for a Talent", "description": "Returns a list of all tags from the *Tags* tab of the talent profile, including custom tag category definitions.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of all tags from the *Tags* tab of the talent profile, including custom tag category definitions.\n\nSource reference: https://developer.avionte.com/reference/gettagsfortalent.md", "operationId": "GetTagsForTalent", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The unique identifier of the talent whose tags are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "117383" } ], "responses": { "200": { "description": "The list of tags for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentAllTagsList" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettagsfortalent.md" } }, "/front-office/v1/talent/{talentId}": { "get": { "tags": [ "Talent" ], "summary": "Get a Talent", "description": "Returns details about the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified talent record.\n\n\n\n
\n\nSource reference: https://developer.avionte.com/reference/gettalent.md", "operationId": "GetTalent", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose details are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "18349" }, { "name": "includeResume", "in": "query", "description": "An indication of whether the resume should be retrieved as part of the request or not. Set this URL parameter to 'True' to retrieve the resume or 'False' to omit it.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested talent record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Talent" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalent.md" }, "post": { "tags": [ "Talent" ], "summary": "Post a Talent", "description": "Creates a new talent or updates an existing talent record if a matching ID is found.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates a new talent or updates an existing talent record if a matching ID is found.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/posttalent.md", "operationId": "PostTalent", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for an existing talent that should be updated, or pass 0 to create a new talent record.", "required": true, "schema": { "type": "string" }, "example": "18484" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Talent" } } }, "required": true }, "responses": { "201": { "description": "The created or updated talent record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Talent" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/posttalent.md" }, "patch": { "tags": [ "Talent" ], "summary": "Patch a Talent", "description": "Patches information about the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-30T17:26:43.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPatches information about the specified talent record.\n\n
\n\n\n If **useNewTalentRequirements** is set to `true` or omitted, the endpoint will follow the New Talent Requirements configured in BOLD, in addition to its default required fields.\n\n If **useNewTalentRequirements** is set to `false`, the endpoint will bypass the New Talent Requirements entirely and allow you to submit the payload without enforcing default required fields.\n\n\nSource reference: https://developer.avionte.com/reference/updatepatchtalent.md", "operationId": "UpdatePatchTalent", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent that should be updated.", "required": true, "schema": { "type": "string" }, "example": "174843" }, { "name": "useNewTalentRequirements", "in": "query", "description": "An indication of whether new talent requirements from BOLD should be used when creating a new talent.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfOperation" } } }, "required": true }, "responses": { "200": { "description": "The updated talent record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ServiceResultOfTalent" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatepatchtalent.md" }, "put": { "tags": [ "Talent" ], "summary": "Update a Talent", "description": "Updates information about the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-30T17:26:43.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates information about the specified talent record.\n\n\n\n
\n\n\n When making a PUT request, make sure to include the entire object in the payload for successful updates. Alternatively, consider using the [Patch a Talent](https://developer.avionte.com/reference/updatepatchtalent) endpoint for partial updates without the need for the entire object.\n\n\n\n\n If **useNewTalentRequirements** is set to `true` or omitted, the endpoint will follow the New Talent Requirements configured in BOLD, in addition to its default required fields.\n\n If **useNewTalentRequirements** is set to `false`, the endpoint will bypass the New Talent Requirements entirely and allow you to submit the payload without enforcing default required fields.\n\n\n
\n\n> 📘 StatusId and Status\n>\n> Either a valid **StatusId** or **Status** value is required to be passed in the payload.\n>\n> If both a valid **StatusId** and a **Status** value are passed in the payload, the endpoint will set the talent status using the provided **StatusId**.\n>\n> If only a valid **Status** value is passed in the payload, the endpoint will set the talent status using the provided **Status** value.\n>\n> * If the tenant has an existing status configured in Table Editor, that matches with the Status value in the payload, then the endpoint will use that value to set the talent's status, else the end point will create a new status in Table Editor and will set the talent's status to that newly created status.\n\nSource reference: https://developer.avionte.com/reference/updatetalent.md", "operationId": "UpdateTalent", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose details should be updated.", "required": true, "schema": { "type": "string" }, "example": "173842" }, { "name": "useNewTalentRequirements", "in": "query", "description": "An indication of whether to use the new talent requirements.", "required": false, "schema": { "type": "string" }, "example": "true" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentDto" } } }, "required": true }, "responses": { "201": { "description": "The updated talent record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Talent" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatetalent.md" } }, "/bo-prod/v3/talent": { "get": { "tags": [ "Talent" ], "summary": "Get a Talent", "description": "Returns the specified talent by external reference or Back Office UUID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-02T19:20:34.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the specified talent by external reference or Back Office UUID.\n\nSource reference: https://developer.avionte.com/reference/gettalent-1.md", "operationId": "GetTalent_bcf365", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalent-1.md", "x-original-operationId": "GetTalent" } }, "/back-office/v1/talent/{applicantId}/1095c": { "get": { "tags": [ "Talent" ], "summary": "Get a List of Talent 1095-C Forms by Applicant ID", "description": "Returns a list of 1095-C forms for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of 1095-C forms for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalent1095clistbyapplicantid.md", "operationId": "GetTalent1095cListByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfTalent1095c" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalent1095clistbyapplicantid.md" } }, "/back-office/v1/reports/1095c/{applicantId}/{form1095cId}": { "get": { "tags": [ "Reports" ], "summary": "Get Talent 1095-C PDF by Applicant ID", "description": "Returns the PDF for the specified Form 1095-C for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the PDF for the specified Form 1095-C for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalent1095cpdfbyapplicantid.md", "operationId": "GetTalent1095cPdfByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "maskSsn", "in": "query", "description": "An indication of whether the SSN (Social Security Number) in the 1095-C PDF should be masked.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "form1095cId", "in": "path", "description": "The identifier for the 1095-C Form.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ByteStringSchema" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalent1095cpdfbyapplicantid.md" } }, "/front-office/v1/talent/{talentId}/1099company": { "get": { "tags": [ "Talent" ], "summary": "Get a Talent 1099 Company", "description": "Returns details about the 1099 company talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the 1099 company talent record.\n\nSource reference: https://developer.avionte.com/reference/gettalent1099company.md", "operationId": "GetTalent1099Company", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose 1099 Company details are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17842" } ], "responses": { "200": { "description": "The talent's 1099 company details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__Talent1099Company" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalent1099company.md" } }, "/back-office/v1/talent/{applicantId}/1099s": { "get": { "tags": [ "Talent" ], "summary": "Get a List of Talent 1099 Forms by Applicant ID", "description": "Returns a list of 1099 forms for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of 1099 forms for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalent1099listbyapplicantid.md", "operationId": "GetTalent1099ListByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfTalent1099" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalent1099listbyapplicantid.md" } }, "/back-office/v1/reports/1099/{applicantId}/{quarterGuid}": { "get": { "tags": [ "Reports" ], "summary": "Get Talent Form 1099 PDF by Applicant ID", "description": "Returns Form 1099 PDF for the specified talent for the specified quarter.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns Form 1099 PDF for the specified talent for the specified quarter.\n\nSource reference: https://developer.avionte.com/reference/gettalent1099pdfbyapplicantid.md", "operationId": "GetTalent1099PdfByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "maskSsn", "in": "query", "description": "An indication of whether the SSN (Social Security Number) in the form PDF should be masked.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "quarterGuid", "in": "path", "description": "The unique identifier (GUID) for the quarter to retrieve the Form 1099 PDF for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ByteStringSchema" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalent1099pdfbyapplicantid.md" } }, "/bo-prod/v3/talent/accrual-options/accrual-plans": { "get": { "tags": [ "Accrual" ], "summary": "Get Talent Accrual Plan Option Items", "description": "Returns the accrual plan options available to the talent, based on their current branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:40:07.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the accrual plan options available to the talent, based on their current branch.\n\nSource reference: https://developer.avionte.com/reference/gettalentaccrualplanoptionitems.md", "operationId": "GetTalentAccrualPlanOptionItems", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 }, { "name": "configAccrualPlanGuid", "in": "query", "description": "The unique identifier for the accrual plan record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentAccrualPlanOptionItemsResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentAccrualOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentaccrualplanoptionitems.md" } }, "/front-office/v1/talent/task/{taskId}": { "get": { "tags": [ "Talent" ], "summary": "Get a Talent Task", "description": "Returns task details for the specified talent task record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns task details for the specified talent task record.\n\nSource reference: https://developer.avionte.com/reference/gettalentactivitytask.md", "operationId": "GetTalentActivityTask", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "taskId", "in": "path", "description": "The identifier for the talent task to retrieve.", "required": true, "schema": { "type": "string" }, "example": "173884" } ], "responses": { "200": { "description": "The requested talent task.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentTaskDto" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentactivitytask.md" } }, "/front-office/v1/talent/{talentId}/assessments": { "get": { "tags": [ "Talent" ], "summary": "Get a List of Talent Assessments", "description": "Retrieves assessment results for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves assessment results for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentassessment.md", "operationId": "GetTalentAssessment", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose assessments are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "18399" } ], "responses": { "200": { "description": "A list of talent assessment results for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentAssessment" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentassessment.md" } }, "/back-office/v1/talent-benefit/{talentGuid}": { "get": { "tags": [ "TalentBenefits", "Talent" ], "summary": "Get Talent Benefit Enrollments", "description": "Returns benefit enrollment details for the specified talent as requested by the authorized partner. This includes a list of talent deductions and employer contributions.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns benefit enrollment details for the specified talent as requested by the authorized partner. This includes a list of talent deductions and employer contributions.\n\nSource reference: https://developer.avionte.com/reference/gettalentbenefitenrollment.md", "operationId": "GetTalentBenefitEnrollment", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "supplierGuid", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "description": "The unique identifier for the supplier (employer) record, formatted as a GUID." } }, { "name": "talentGuid", "in": "path", "description": "The unique identifier for the talent, formatted as a GUID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfTalentBenefit" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentbenefitenrollment.md" } }, "/back-office/v1/talent-benefit-partner/payroll-deductions": { "get": { "tags": [ "Talent Benefit Partner" ], "summary": "Get Talent Benefit Payroll Deductions", "description": "Returns a paged result of paycheck deductions, including the caller's talent benefit deduction transaction types, filtered by accounting period date in format YYYY-MM-DD and employment supplier UUID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged result of paycheck deductions, including the caller's talent benefit deduction transaction types, filtered by accounting period date in format YYYY-MM-DD and employment supplier UUID.\n\nSource reference: https://developer.avionte.com/reference/gettalentbenefitpartnerpayrolldeductions.md", "operationId": "GetTalentBenefitPartnerPayrollDeductions", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "supplierGuid", "in": "query", "description": "The unique identifier for the employment supplier, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountingPeriodDate", "in": "query", "description": "The accounting period date to review, formatted as: YYYY-MM-DD", "required": true, "schema": { "type": "string" }, "x-example": "2026-01-18" } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__BulkDataPageOfPayrollDeduction" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentbenefitpartnerpayrolldeductions.md" } }, "/back-office/v1/partner-reference/talent-benefits/{talentGuid}": { "get": { "tags": [ "Partner References" ], "summary": "Get Partner Talent Benefit References", "description": "Returns key-value pairs of all Reference Groups and Reference Options for a specified talent. The authenticated API requestor must be a Talent Benefit partner; otherwise, an error is returned.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns key-value pairs of all Reference Groups and Reference Options for a specified talent. The authenticated API requestor must be a Talent Benefit partner; otherwise, an error is returned.\n\nSource reference: https://developer.avionte.com/reference/gettalentbenefitpartnerreference.md", "operationId": "GetTalentBenefitPartnerReference", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "talentGuid", "in": "path", "description": "The unique identifier for the talent, formatted as a GUID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfBenefitPartnerReference" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentbenefitpartnerreference.md" } }, "/back-office/v1/talent-benefit/ytd/{yearId}": { "post": { "tags": [ "TalentBenefits" ], "summary": "Get Talent Benefit YTD Summaries", "description": "Returns year-to-date benefit summaries for the specified talents for a given year. Includes gross wages, hours worked, payroll deductions, and employer contributions. Accepts up to 100 talent GUIDs per request.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns year-to-date benefit summaries for the specified talents for a given year. Includes gross wages, hours worked, payroll deductions, and employer contributions. Accepts up to 100 talent GUIDs per request.\n\nSource reference: https://developer.avionte.com/reference/gettalentbenefitytdsummaries.md", "operationId": "GetTalentBenefitYtdSummaries", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "yearId", "in": "path", "description": "The year ID in `yyyy` format.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfGuids" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfTalentBenefitYtdSummary" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentbenefitytdsummaries.md" } }, "/front-office/v1/talent/certificate/{certificateId}/documents": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Certificate Documents", "description": "Returns a list of documents that have been associated to a talent's certificate record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of documents that have been associated to a talent's certificate record.\n\nSource reference: https://developer.avionte.com/reference/gettalentcertificatedocuments.md", "operationId": "GetTalentCertificateDocuments", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "certificateId", "in": "path", "description": "The identifier for the talent certificate for which documents are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "4827" } ], "responses": { "200": { "description": "A list of documents associated with the talent certificate.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentCertificateDocument" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentcertificatedocuments.md" } }, "/front-office/v1/talent/{talentId}/certificates": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Certificates", "description": "Returns a list of certificates associated with the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of certificates associated with the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentcertificates.md", "operationId": "GetTalentCertificates", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The talent's identifier whose certificates will be retrieved.", "required": true, "schema": { "type": "string" }, "example": "184992" } ], "responses": { "200": { "description": "A list of certificates for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentCertificate" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentcertificates.md" } }, "/bo-prod/v3/talent/tax-options/check-delivery": { "get": { "tags": [ "Payroll" ], "summary": "Get Check Delivery Options", "description": "Returns a predefined list of available check delivery options for the specified branch.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:49:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a predefined list of available check delivery options for the specified branch.\n\nSource reference: https://developer.avionte.com/reference/gettalentcheckdelivery.md", "operationId": "GetTalentCheckDelivery", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "branchGuid", "in": "query", "description": "The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.", "schema": { "type": "string", "format": "uuid" }, "example": "75997192-a570-4087-baab-e08d84448956" }, { "name": "branchExternalId", "in": "query", "description": "The external ID of the Branch entity, used as an alternative to the __BranchGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Branch entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __BranchGuid__ header containing the classic entity record ID.", "schema": { "type": "string" }, "example": 1392 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "includeInactive", "in": "query", "description": "An indication of whether to include disabled or inactive statuses in the response. New records cannot be created with an inactive status.", "required": false, "schema": { "type": "string" }, "example": true } ], "responses": { "200": { "description": "A predefined list of check delivery options.", "headers": { "RequestId": { "$ref": "#/components/headers/bo_prod__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__CustomSetupOptionArray" }, "examples": { "Example 1": { "value": [ { "optionId": 42, "optionName": "Mail to Home", "categoryId": 8, "categoryName": "Check Delivery", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [] }, { "optionId": 43, "optionName": "Direct Deposit", "categoryId": 8, "categoryName": "Check Delivery", "branchGuid": "75997192-a570-4087-baab-e08d84448956", "isVisible": true, "customSetupOptionProperties": [] } ] } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentcheckdelivery.md" } }, "/front-office/v1/talent/{talentId}/communication-preferences": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Communication Preferences", "description": "Returns the communication preferences for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the communication preferences for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentcommunicationpreferences.md", "operationId": "GetTalentCommunicationPreferences", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose communication preferences are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17384" } ], "responses": { "200": { "description": "The communication preferences for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCommPreference" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentcommunicationpreferences.md" }, "post": { "tags": [ "Talent" ], "summary": "Post Talent Communication Preferences", "description": "Adds or updates communication preferences for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdds or updates communication preferences for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/savetalentcommunicationpreferences.md", "operationId": "SaveTalentCommunicationPreferences", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose communication preferences should be updated.", "required": true, "schema": { "type": "string" }, "example": "17484" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCommPreference" } } }, "required": true }, "responses": { "200": { "description": "The communication preferences for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentCommPreference" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/savetalentcommunicationpreferences.md" } }, "/back-office/v1/talent-deduction/{talentGuid}": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Deductions", "description": "Returns a list of talent deductions for the specified talent. Transaction type names are masked for security/privacy reasons.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of talent deductions for the specified talent. Transaction type names are masked for security/privacy reasons.\n\nSource reference: https://developer.avionte.com/reference/gettalentdeductions.md", "operationId": "GetTalentDeductions", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "talentGuid", "in": "path", "description": "The unique identifier for the talent, formatted as a GUID.", "required": true, "explode": false, "schema": { "type": "string" } }, { "name": "activeOnly", "in": "query", "description": "An indication of whether to exclude inactive deductions in the result. Defaults to true.", "required": false, "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfTalentDeduction" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentdeductions.md" } }, "/front-office/v1/talent/{talentId}/direct-deposit-accounts": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Direct Deposit Accounts", "description": "Returns a list of bank accounts associated with the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of bank accounts associated with the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentdirectdepositaccounts.md", "operationId": "GetTalentDirectDepositAccounts", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "An identifier for the talent whose direct deposit accounts are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17883" }, { "name": "includeArchived", "in": "query", "description": "An indication of whether archived accounts are included in the response. When `true`, both active and archived accounts are returned. When `false` (default), only active accounts are returned.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "The list of direct deposit accounts associated with the talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfDirectDepositBankAccount" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentdirectdepositaccounts.md" }, "post": { "tags": [ "Talent" ], "summary": "Save Talent Direct Deposit Accounts", "description": "Creates, updates, and removes the talent’s direct deposit bank accounts by synchronizing existing records to the bank accounts provided in the request.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates, updates, and removes the talent’s direct deposit bank accounts by synchronizing existing records to the bank accounts provided in the request.\n\n> ⚠️\n>\n> Although the **id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\nSource reference: https://developer.avionte.com/reference/savetalentdirectdepositaccounts.md", "operationId": "SaveTalentDirectDepositAccounts", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "An identifier for the talent whose direct deposit accounts are being saved.", "required": true, "schema": { "type": "string" }, "example": "17844" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfBankAccount" } } }, "required": true }, "responses": { "201": { "description": "The list of direct deposit accounts associated with the talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfBankAccount" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/savetalentdirectdepositaccounts.md" } }, "/front-office/v1/talent/{talentId}/document-links": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Document Links", "description": "Returns a list of document records for the specified talent with pre-signed URLs that can be used to download the document contents. The pre-signed URLs have a 5-minute expiration time.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of document records for the specified talent with pre-signed URLs that can be used to download the document contents. The pre-signed URLs have a 5-minute expiration time.\n\nSource reference: https://developer.avionte.com/reference/gettalentdocumentlinks.md", "operationId": "GetTalentDocumentLinks", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose document links are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "184282" } ], "responses": { "200": { "description": "The list of document records for the specified talent with pre-signed URLs that can be used to download the document contents. The pre-signed URLs have a 5-minute expiration time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentDocumentLink" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentdocumentlinks.md" } }, "/front-office/v1/talent/{talentId}/document": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Documents", "description": "Returns a list of documents for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of documents for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentdocuments.md", "operationId": "GetTalentDocuments", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose documents are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "184282" } ], "responses": { "200": { "description": "The list of documents for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentDocument" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentdocuments.md" } }, "/front-office/v1/talent-document-types": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Document Types", "description": "Returns a list of the available document types that can be uploaded to the talent profile. Talent documents are available on the *Documents* tab of the talent profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of the available document types that can be uploaded to the talent profile. Talent documents are available on the *Documents* tab of the talent profile.\n\nSource reference: https://developer.avionte.com/reference/gettalentdocumenttypes.md", "operationId": "GetTalentDocumentTypes", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of available document types.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentDocTypes" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentdocumenttypes.md" } }, "/bo-prod/v3/talent/hours/detail": { "post": { "tags": [ "Talent" ], "summary": "Get Details for Hours Worked", "description": "Returns a list of detail rows for a given set of hours.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:39:02.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of detail rows for a given set of hours.\n\nSource reference: https://developer.avionte.com/reference/gettalenthoursworkeddetail.md", "operationId": "GetTalentHoursWorkedDetail", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__arrayOfGuids" }, "responses": { "200": { "$ref": "#/components/responses/bo_prod__HoursHistoryDetailPostResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "409": { "$ref": "#/components/responses/bo_prod__apiResultDuplicate409" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "HoursController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalenthoursworkeddetail.md" } }, "/back-office/v1/talent/multi-query": { "post": { "tags": [ "Talent" ], "summary": "Query Multiple Talent by TalentGuids", "description": "Retrieves details about the specified talent records.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves details about the specified talent records.\n\nSource reference: https://developer.avionte.com/reference/gettalentmultiquery.md", "operationId": "GetTalentMultiQuery", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } ], "requestBody": { "$ref": "#/components/requestBodies/back_office__multiQueryRequest" }, "responses": { "200": { "$ref": "#/components/responses/back_office__talentMultiQuery200Response" }, "207": { "$ref": "#/components/responses/back_office__talentMultiQuery207Response" }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentmultiquery.md" } }, "/front-office/v1/talent/{talentId}/talent-onboarding-tasks": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Onboarding Tasks", "description": "Returns the onboarding tasks assigned to a specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the onboarding tasks assigned to a specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentonbordingtasks.md", "operationId": "GetTalentOnbordingTasks", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "An identifier for the talent whose onboarding tasks are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17884" } ], "responses": { "200": { "description": "The list of onboarding tasks assigned to the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentOnboardingTaskDto" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentonbordingtasks.md" } }, "/back-office/v2/talent/paycheck/{applicantId}/{paymentCheckGuid}/detail": { "get": { "tags": [ "Paychecks" ], "summary": "Get Details About the Talent Paycheck", "description": "Returns detailed information about the specified paycheck for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns detailed information about the specified paycheck for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentpaycheckdetails.md", "operationId": "GetTalentPaycheckDetails", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "paymentCheckGuid", "in": "path", "description": "The unique identifier for the paycheck, formatted as GUID.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent whose data is being queried.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentPayCheckDetailV2" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentpaycheckdetails.md" } }, "/back-office/v2/talent/paycheck/{applicantId}": { "get": { "tags": [ "Paychecks" ], "summary": "Get a List of Talent Paychecks", "description": "Returns a list of paychecks for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of paychecks for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentpaychecklist.md", "operationId": "GetTalentPaycheckList", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "pageSize", "in": "query", "description": "The number of records to return per page in a paginated response.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent whose data is being queried.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "The page number to retrieve in a paginated response.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__PagedResultsOfTalentPayCheckV2" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentpaychecklist.md" } }, "/front-office/v1/talent/{talentId}/pay-requirements": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Pay Requirements", "description": "Returns the talent's pay requirements from the *Operational Information* section of the talent profile, including salary and hourly rate ranges and bonus accrual settings.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-08-05T18:08:57.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the talent's pay requirements from the *Operational Information* section of the talent profile, including salary and hourly rate ranges and bonus accrual settings.\n\nSource reference: https://developer.avionte.com/reference/gettalentpayrequirements.md", "operationId": "GetTalentPayRequirements", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose pay requirements are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17847" } ], "responses": { "200": { "description": "The talent's pay requirements.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentProfilePayRequirements" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentpayrequirements.md" } }, "/front-office/v1/talent/{talentId}/placement/{page}/{pageSize}": { "get": { "tags": [ "Placements" ], "summary": "Get Placements by Talent ID", "description": "Returns placements for a talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-08-14T19:14:30.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns placements for a talent.\n\n\n If `fromDate` and `toDate` are not provided, the endpoint returns placements from the previous **365 days** by default.\n\n\nSource reference: https://developer.avionte.com/reference/gettalentplacementsbydate.md", "operationId": "GetTalentPlacementsByDate", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "description": "The page number to retrieve. The minimum value is 1.", "required": true, "schema": { "type": "string" }, "example": 1 }, { "name": "pageSize", "in": "path", "description": "The page size to retrieve. The minimum value is 1, the maximum value is 100.", "required": true, "schema": { "type": "string" }, "example": 1 }, { "name": "talentId", "in": "path", "description": "The unique identifier for the talent to retrieve.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fromDate", "in": "query", "description": "The placement search start date.", "required": false, "schema": { "type": "string" }, "example": "2024-12-01" }, { "name": "toDate", "in": "query", "description": "The placement search end date.", "required": false, "schema": { "type": "string" }, "example": "2024-12-01" } ], "responses": { "200": { "description": "The placements details.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__PlacementExtension" } } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentplacementsbydate.md" } }, "/front-office/v1/talent/{talentId}/questionnaire": { "get": { "tags": [ "Talent" ], "summary": "Get a List of Talent Questionnaires", "description": "Retrieves questionnaires from the profile of the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves questionnaires from the profile of the specified talent record.\n\nSource reference: https://developer.avionte.com/reference/gettalentquestionnaire.md", "operationId": "GetTalentQuestionnaire", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose questionnaires are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17838" } ], "responses": { "200": { "description": "A list of talent questionnaires.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfApplicantQuestionnaire" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentquestionnaire.md" } }, "/front-office/v1/talent/{talentId}/skills": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Skills", "description": "Returns a list of skills from the *Tags* tab for the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of skills from the *Tags* tab for the specified talent record.\n\nSource reference: https://developer.avionte.com/reference/gettalentskills.md", "operationId": "GetTalentSkills", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "An identifier for the talent whose skills are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "17488" } ], "responses": { "200": { "description": "The skills for the talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentSkill" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentskills.md" } }, "/front-office/v1/talent/stage/{nominationId}": { "get": { "tags": [ "Talent" ], "summary": "Get a Talent Nomination Stage", "description": "Returns details about the specified talent nomination stage.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified talent nomination stage.\n\nSource reference: https://developer.avionte.com/reference/gettalentstage.md", "operationId": "GetTalentStage", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "nominationId", "in": "path", "description": "The identifier for the talent nomination stage that should be retrieved.", "required": true, "schema": { "type": "string" }, "example": "27842" } ], "responses": { "200": { "description": "The requested talent nomination stage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentStage" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentstage.md" }, "put": { "tags": [ "Talent" ], "summary": "Update a Talent Nomination Stage", "description": "Updates the specified talent nomination stage.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the specified talent nomination stage.\n\n> ⚠️\n>\n> When making a PUT request, make sure to include the entire object in the payload for successful updates.\n\nSource reference: https://developer.avionte.com/reference/update-talentstage.md", "operationId": "UpdateTalentStage", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "nominationId", "in": "path", "description": "The identifier for the talent nomination stage that should be updated.", "required": true, "schema": { "type": "string" }, "example": "17842" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentStage" } } }, "required": true }, "responses": { "201": { "description": "The updated talent nomination stage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentStage" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/update-talentstage.md", "x-original-operationId": "Update TalentStage" } }, "/back-office/v1/reports/T4A/{applicantId}/{supplierGuid}/{yearId}": { "get": { "tags": [ "Reports" ], "summary": "Get Talent T4A Report by Applicant ID", "description": "Returns a T4A report for the specified talent for the specified year.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a T4A report for the specified talent for the specified year.\n\nSource reference: https://developer.avionte.com/reference/gettalentt4apdfbyapplicantid.md", "operationId": "GetTalentT4APdfByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "supplierGuid", "in": "path", "description": "The unique identifier for the staffing company (supplier), formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "yearId", "in": "path", "description": "The identifier for the tax year of the report.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "maskSin", "in": "query", "description": "An indication of whether the SIN (Social Insurance Number) in the report should be masked.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ByteStringSchema" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentt4apdfbyapplicantid.md" } }, "/back-office/v1/talent/{applicantId}/T4As": { "get": { "tags": [ "Talent" ], "summary": "Get a List of Talent T4A Forms by Applicant ID", "description": "Returns a list of T4A forms for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of T4A forms for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentt4asbyapplicantid.md", "operationId": "GetTalentT4AsByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfTalentT4A" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentt4asbyapplicantid.md" } }, "/back-office/v1/reports/T4/{applicantId}/{supplierGuid}/{yearId}": { "get": { "tags": [ "Reports" ], "summary": "Get Talent T4 Report by Applicant ID", "description": "Returns a T4 report for the specified talent for the specified year.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a T4 report for the specified talent for the specified year.\n\nSource reference: https://developer.avionte.com/reference/gettalentt4pdfbyapplicantid.md", "operationId": "GetTalentT4PdfByApplicantId", "parameters": [ { "name": "supplierGuid", "in": "path", "description": "The unique identifier for the staffing company (supplier), formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "yearId", "in": "path", "description": "The calendar year for which the T4 report is being requested.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "applicantId", "in": "path", "description": "The identifier of the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "maskSin", "in": "query", "description": "An indication of whether the SIN (Social Insurance Number) in the report should be masked.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ByteStringSchema" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentt4pdfbyapplicantid.md" } }, "/back-office/v1/talent/{applicantId}/T4s": { "get": { "tags": [ "Talent" ], "summary": "Get a List of Talent T4 Forms by Applicant ID", "description": "Returns a list of T4 forms for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of T4 forms for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentt4sbyapplicantid.md", "operationId": "GetTalentT4sByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfTalentT4" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentt4sbyapplicantid.md" } }, "/front-office/v1/talent-tag-definitions": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Tag Definitions", "description": "Returns a list of dropdown values for the talent tag definitions from the *Tags* tab of the talent profile.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of dropdown values for the talent tag definitions from the *Tags* tab of the talent profile.\n\nSource reference: https://developer.avionte.com/reference/gettalenttagdefinitions.md", "operationId": "GetTalentTagDefinitions", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of talent tag definitions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentTagDefinitions" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalenttagdefinitions.md" } }, "/back-office/v1/talent/tax-details": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Tax Details", "description": "Returns Tax setup details for the specified talent record for Employers.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns Tax setup details for the specified talent record for Employers.\n\nSource reference: https://developer.avionte.com/reference/gettalenttaxdetails.md", "operationId": "GetTalentTaxDetails", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier for the talent, formatted as a GUID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfTalentTaxDetail" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalenttaxdetails.md" } }, "/bo-prod/v3/talent/tax-details": { "get": { "tags": [ "Taxes" ], "summary": "Get Talent Tax Details", "description": "Returns tax details for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:40:50.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns tax details for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalenttaxdetails-1.md", "operationId": "GetTalentTaxDetails_0e031c", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentTaxDetailResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalenttaxdetails-1.md", "x-original-operationId": "GetTalentTaxDetails" } }, "/bo-prod/v3/talent/tax-history": { "get": { "tags": [ "Taxes" ], "summary": "Get Talent Tax History", "description": "Returns tax history for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-30T16:41:01.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns tax history for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalenttaxhistory.md", "operationId": "GetTalentTaxHistory", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TalentTaxHistoryResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalenttaxhistory.md" } }, "/bo-prod/v3/talent/tax-options/tax": { "get": { "tags": [ "Taxes" ], "summary": "Get a List of Available Taxes", "description": "Returns a list of taxes available to set up for the talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:13:41.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of taxes available to set up for the talent record.\n\nSource reference: https://developer.avionte.com/reference/gettalenttaxoptions.md", "operationId": "GetTalentTaxOptions", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "searchTerm", "in": "query", "description": "A general-use string value representing a value to be searched for.", "schema": { "type": "string" }, "example": "Smith" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TaxOptionsTaxResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalenttaxoptions.md" } }, "/back-office/v1/reports/w2/{applicantId}/{w2Guid}": { "get": { "tags": [ "Reports" ], "summary": "Get Talent Form W-2 PDF by Applicant ID", "description": "Returns the PDF for the specified Form W-2 for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns the PDF for the specified Form W-2 for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentw2pdfbyapplicantid.md", "operationId": "GetTalentW2PdfByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "w2Guid", "in": "path", "description": "The unique identifier (GUID) for the Form W-2 PDF.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "maskSsn", "in": "query", "description": "An indication of whether the SSN (Social Security Number) in the Form W-2 PDF should be masked.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ByteStringSchema" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentw2pdfbyapplicantid.md" } }, "/back-office/v1/talent/{applicantId}/w2s": { "get": { "tags": [ "Talent" ], "summary": "Get a List of Talent W-2 Forms by Applicant ID", "description": "Returns a list of W-2 forms for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of W-2 forms for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/gettalentw2sbyapplicantid.md", "operationId": "GetTalentW2sByApplicantId", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "sort", "in": "query", "description": "The field name by which to sort the results.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortDescending", "in": "query", "description": "An indication of whether the results should be sorted in descending order.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfTalentW2" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettalentw2sbyapplicantid.md" } }, "/bo-prod/v3/talent/tax-options/tax-county": { "get": { "tags": [ "Taxes" ], "summary": "Get a List of Available Counties", "description": "Returns a list of available counties for the state withholding setup.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:13:41.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of available counties for the state withholding setup.\n\nSource reference: https://developer.avionte.com/reference/gettaxcounties.md", "operationId": "GetTaxCounties", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "stateCode", "in": "query", "description": "The state code representing a state or province.", "schema": { "type": "string" }, "example": "MN" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TaxCountyOptionsResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettaxcounties.md" } }, "/bo-prod/v3/talent/tax-options/tax-filing-status": { "get": { "tags": [ "Taxes" ], "summary": "Get a List of Available Tax Filing Statuses", "description": "Returns a list of available filing statuses for the specified tax.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:13:41.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of available filing statuses for the specified tax.\n\nSource reference: https://developer.avionte.com/reference/gettaxfilingstatus.md", "operationId": "GetTaxFilingStatus", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "taxId", "in": "query", "description": "The unique identifier for a Tax record.", "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "effectiveDate", "in": "query", "description": "A general use datetime value representing a specific point in time, used to compare against a date range. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format, for example, 2026-12-01 or 2026-12-01T14:30:00.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-12-01T14:30:00Z" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__TaxFilingStatusOptionsResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettaxfilingstatus.md" } }, "/back-office/v1/time-entry/{timeEntryBatchGuid}": { "get": { "tags": [ "Time" ], "summary": "Get Time Entries by Time Entry Batch GUID", "description": "Retrieves a paginated list of time entries for the requested time entry batch GUID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves a paginated list of time entries for the requested time entry batch GUID.\n\nSource reference: https://developer.avionte.com/reference/gettimeentriesbytimeentrybatchguid.md", "operationId": "GetTimeEntriesByTimeEntryBatchGuid", "parameters": [ { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "timeEntryBatchGuid", "in": "path", "description": "The unique identifier for the time entry batch, formatted as a GUID.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__PagedResultsOfTransactionSummary" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/gettimeentriesbytimeentrybatchguid.md" } }, "/front-office/v1/user/{userId}": { "get": { "tags": [ "Users" ], "summary": "Get a Talent User by ID", "description": "Returns details about the specified talent user.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified talent user.\n\nSource reference: https://developer.avionte.com/reference/getuserbyid.md", "operationId": "GetUserById", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The talent user record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ApiUser" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getuserbyid.md" }, "patch": { "tags": [ "Users" ], "summary": "Update an HCM User", "description": "Updates an existing HCM User record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates an existing HCM User record.\n\nSource reference: https://developer.avionte.com/reference/updatehcmuser.md", "operationId": "UpdateHcmUser", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "An array of JSON Patch Document operations. Each operation object in the array has a common structure, including an \"op\" field specifying the type of operation and a \"path\" field using JSON Pointer syntax to identify the target location within the document. Refer to jsonpatch.com for more information. Supported operations for this endpoint are \"replace\", \"add\", and \"remove\". Note that valid values for the \"/status\" path are \"Active\" and \"Inactive\". The \"add\" and \"remove\" operations are only valid for the \"/officeAccess\" and \"/userGroups\" paths.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfOperation" }, "example": [ { "op": "replace", "path": "/firstName", "value": "John" }, { "op": "replace", "path": "/lastName", "value": "Doe" }, { "op": "replace", "path": "/emailAddress", "value": "john.doe@example.com" }, { "op": "replace", "path": "/emailAddress2", "value": "john.doe2@example.com" }, { "op": "replace", "path": "/homePhone", "value": "555-123-4567" }, { "op": "replace", "path": "/mobilePhone", "value": "555-987-6543" }, { "op": "replace", "path": "/workPhone", "value": "555-555-5555" }, { "op": "replace", "path": "/faxPhone", "value": "555-555-6666" }, { "op": "replace", "path": "/street1", "value": "123 Main St" }, { "op": "replace", "path": "/street2", "value": "Apt 4B" }, { "op": "replace", "path": "/city", "value": "Anytown" }, { "op": "replace", "path": "/stateProvince", "value": "CA" }, { "op": "replace", "path": "/postalCode", "value": "12345" }, { "op": "replace", "path": "/country", "value": "US" }, { "op": "replace", "path": "/homeOfficeId", "value": 7890 }, { "op": "replace", "path": "/status", "value": "Active" }, { "op": "add", "path": "/officeAccess/-", "value": 356 }, { "op": "remove", "path": "/officeAccess", "value": 567 }, { "op": "replace", "path": "/officeAccess", "value": [ 356, 567, 621 ] }, { "op": "add", "path": "/userGroups/-", "value": 23 }, { "op": "remove", "path": "/userGroups", "value": 34 }, { "op": "replace", "path": "/userGroups", "value": [ 23, 34, 84 ] } ] } }, "required": true }, "responses": { "200": { "description": "The HCM user record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ApiUser" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatehcmuser.md" } }, "/front-office/v1/user/user-groups": { "get": { "tags": [ "Users" ], "summary": "Get User Groups", "description": "Returns a list of configured user groups for the tenant.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of configured user groups for the tenant.\n\nSource reference: https://developer.avionte.com/reference/getusergroups.md", "operationId": "GetUserGroups", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "The list of configured user groups for the specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfUserGroup" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getusergroups.md" } }, "/front-office/v1/user/user-types": { "get": { "tags": [ "Users" ], "summary": "Get User Types", "description": "Returns a list of configured user types for the tenant.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of configured user types for the tenant.\n\nSource reference: https://developer.avionte.com/reference/getusertypes.md", "operationId": "GetUserTypes", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "The list of configured user types for the specified tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfUserType" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getusertypes.md" } }, "/front-office/v1/job/vms-jobs/{vmsId}": { "get": { "tags": [ "Jobs" ], "summary": "Get VMS Jobs by VMS ID", "description": "Returns details about the VMS jobs associated with the specified VMS ID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the VMS jobs associated with the specified VMS ID.\n\nSource reference: https://developer.avionte.com/reference/getvmsjobbyvmsid.md", "operationId": "GetVmsJobByVmsId", "parameters": [ { "name": "vmsId", "in": "path", "description": "The job identifier from the external VMS system.", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } } ], "responses": { "200": { "description": "An array of VMS Jobs for the requested VMS ID.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__VmsJobBasicDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Access Denied" }, "404": { "description": "Not Found" }, "406": { "description": "Unsupported format(s) indicated by Accept header" }, "415": { "description": "Unsupported format(s) indicated by the Content-Type header" }, "429": { "description": "Too many requests" }, "500": { "description": "An unexpected error occurred" }, "502": { "description": "Service Unavailable" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getvmsjobbyvmsid.md" } }, "/front-office/v1/work-comp": { "get": { "tags": [ "Companies", "Jobs" ], "summary": "Get Workers Comp Codes", "description": "Returns a list of available workers compensation codes that can be assigned to companies and jobs and their details.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of available workers compensation codes that can be assigned to companies and jobs and their details.\n\nSource reference: https://developer.avionte.com/reference/getworkcompcode.md", "operationId": "GetWorkCompCode", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "responses": { "200": { "description": "A list of workers compensation codes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfWorkerCompCode" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/getworkcompcode.md" } }, "/bo-prod/v3/billing/option-items/invoice-to-department": { "get": { "tags": [ "Billing" ], "summary": "Invoice To Department Options", "description": "Returns a list of company departments that can be used to specify where billing should be invoiced to. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T20:12:56.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of company departments that can be used to specify where billing should be invoiced to. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.\n\nSource reference: https://developer.avionte.com/reference/invoicetodepartmentoptions.md", "operationId": "InvoiceToDepartmentOptions", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "companyExternalId", "in": "query", "description": "The external ID of the Company entity, used as an alternative to the __CompanyGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Company entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __CompanyGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 366992 }, { "name": "departmentExternalId", "in": "query", "description": "The unique identifier for a Department record, formatted as a UUID.", "schema": { "type": "string" }, "example": 458434 }, { "name": "companyGuid", "in": "query", "description": "The unique identifier for a Company record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22" } ], "responses": { "200": { "$ref": "#/components/responses/bo_prod__InvoiceToDeparmentGetResponse" }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "409": { "$ref": "#/components/responses/bo_prod__apiResultDuplicate409" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "BillingOptionItemsController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/invoicetodepartmentoptions.md" } }, "/front-office/v1/jobs/ids/{page}/{pageSize}": { "get": { "tags": [ "Jobs" ], "summary": "Get Job IDs", "description": "Returns a paged list of all job IDs registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of all job IDs registered in the system.\n\nSource reference: https://developer.avionte.com/reference/jobids.md", "operationId": "JobIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "description": "The page number to retrieve in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "pageSize", "in": "path", "description": "The number of records to include per page in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "50" } ], "responses": { "200": { "description": "A paged list of job IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 1848945, 1674824, 1485992 ] } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/jobids.md" } }, "/front-office/v1/talent/{talentId}/onboarding-documents": { "get": { "tags": [ "Talent" ], "summary": "Get Talent Adobe Onboarding Documents", "description": "Retrieves completed Adobe E-Sign documents for a specified talent. Supports optional pagination via query parameters.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-30T17:26:43.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRetrieves completed Adobe E-Sign documents for a specified talent. Supports optional pagination via query parameters.\n\n\n If a request fails when using the maximum `pageSize`, retry with a smaller value. The optimal `pageSize` depends on the size of the documents being retrieved.\n\n This endpoint excludes records where `isArchived=1` and files with names containing *AUDIT.pdf*.\n\n\n
\n\nSource reference: https://developer.avionte.com/reference/onboardingdocuments.md", "operationId": "OnboardingDocuments", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "An identifier for the talent whose onboarding documents are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "148922" }, { "name": "page", "in": "query", "description": "The 1-based page number. Must be provided together with pageSize.", "required": false, "schema": { "type": "integer", "format": "int32", "nullable": true }, "example": "1" }, { "name": "pageSize", "in": "query", "description": "The number of records per page. Must be provided together with page. Maximum allowed value is 10; larger values are silently capped at 10.", "required": false, "schema": { "type": "integer", "format": "int32", "nullable": true }, "example": "5" } ], "responses": { "200": { "description": "A list of completed Adobe E-Sign documents for the specified talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfAdobeESignDocument" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/onboardingdocuments.md" } }, "/front-office/v1/job/vms-job/{vmsJobId}": { "patch": { "tags": [ "Jobs" ], "summary": "Patch a VMS Job", "description": "Patches information about the specified VMS Job and related Bold Job if it exists.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPatches information about the specified VMS Job and related Bold Job if it exists.\n\nSource reference: https://developer.avionte.com/reference/patchvmsjob.md", "operationId": "PatchVmsJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "vmsJobId", "in": "path", "description": "The identifier for the VMS job in BOLD.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfOperation" } } }, "required": true }, "responses": { "200": { "description": "The updated VMS job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__VMSJobDTO" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/patchvmsjob.md" }, "put": { "tags": [ "Jobs" ], "summary": "Update a VMS Job", "description": "Updates an existing VMS job record in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates an existing VMS job record in the system.\n\n> ⚠️\n>\n> When making a PUT request, make sure to include the entire object in the payload for successful updates.\n\nSource reference: https://developer.avionte.com/reference/update-vms-job.md", "operationId": "UpdateVMSJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "vmsJobId", "in": "path", "description": "The identifier for the VMS job in BOLD.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__VMSJobDTO" } } }, "required": true }, "responses": { "200": { "description": "The updated VMS job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__VMSJobDTO" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/update-vms-job.md", "x-original-operationId": "Update VMS Job" } }, "/front-office/v1/placements/ids/{page}/{pageSize}": { "get": { "tags": [ "Placements" ], "summary": "Get Placement IDs", "description": "Returns a paged list of all placement IDs registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of all placement IDs registered in the system.\n\nSource reference: https://developer.avionte.com/reference/placementids.md", "operationId": "PlacementIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "description": "The page number to retrieve.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "pageSize", "in": "path", "description": "The number of placement IDs to include in each page of results.", "required": true, "schema": { "type": "string" }, "example": "10" } ], "responses": { "200": { "description": "A paged list of placement IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 1848945, 1674824, 1485992 ] } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/placementids.md" } }, "/back-office/v1/talent/supplemental-benefits/eligibility": { "post": { "tags": [ "TalentSupplementalBenefits" ], "summary": "Post Talent Supplemental Benefit Eligibility", "description": "Determine talent supplemental benefit eligibility and remove payroll hold.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nDetermine talent supplemental benefit eligibility and remove payroll hold.\n\nSource reference: https://developer.avionte.com/reference/posttalentsupplementalbenefiteligibility.md", "operationId": "PostTalentSupplementalBenefitEligibility", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "talentGuid", "in": "query", "description": "The talent Guid identifier.", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "guid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentSupplementalBenefitsEligibility" } } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentSupplementalBenefitsEligibility" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/posttalentsupplementalbenefiteligibility.md" } }, "/events/": { "post": { "tags": [ "Events" ], "summary": "Add Events", "description": "Add a batch of events to an Azure Event Grid topic.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2024-12-12T12:30:24.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nAdd a batch of events to an Azure Event Grid topic.\n\nSource reference: https://developer.avionte.com/reference/publishevents.md", "operationId": "PublishEvents", "parameters": [ { "name": "aeg-sas-key", "in": "header", "description": "Contains the caller's access key for the Event Grid Topic", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "An array of events to be published to Event Grid.", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "data", "dataVersion", "eventTime", "eventType", "id", "subject" ], "type": "object", "properties": { "id": { "type": "string", "description": "An unique identifier for the event." }, "topic": { "type": "string", "description": "The resource path of the event source." }, "subject": { "type": "string", "description": "A resource path relative to the topic path." }, "data": { "type": "object", "description": "Event data specific to the event type." }, "eventType": { "type": "string", "description": "The type of the event that occurred." }, "eventTime": { "type": "string", "description": "The time (in UTC) the event was generated.", "format": "date-time" }, "metadataVersion": { "type": "string", "description": "The schema version of the event metadata." }, "dataVersion": { "type": "string", "description": "The schema version of the data object." } }, "description": "Properties of an event published to an Event Grid topic.", "x-readme-ref-name": "EventGridEvent" }, "x-readme-ref-name": "ArrayOfEventGridEvent" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": {} }, "400": { "description": "Bad Request", "content": {} }, "403": { "description": "Access Denied", "content": {} }, "404": { "description": "Not Found", "content": {} }, "429": { "description": "Too many events", "content": {} }, "500": { "description": "An unexpected error occurred", "content": {} } }, "security": [ { "events__api_key": [] } ], "x-reference-page": "https://developer.avionte.com/reference/publishevents.md" } }, "/front-office/v1/talent/all-tags/multi-query": { "post": { "tags": [ "Talent" ], "summary": "Query All Tags For Multiple Talents", "description": "Returns a list of tags from the *Tags* tab assigned to the specified talent records.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of tags from the *Tags* tab assigned to the specified talent records.\n\nSource reference: https://developer.avionte.com/reference/query-all-tags-for-multiple-talent.md", "operationId": "QueryAllTagsForMultipleTalent", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "A list of talent IDs for which to retrieve tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 1738134, 1738135, 1738136 ] } }, "required": true }, "responses": { "200": { "description": "A list of tags from the *Tags* tab assigned to the specified talent records.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentAllTags" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/query-all-tags-for-multiple-talent.md", "x-original-operationId": "Query All Tags For Multiple Talent" } }, "/front-office/v1/departments/multi-query": { "post": { "tags": [ "Departments" ], "summary": "Query Multiple Departments", "description": "Returns details about the specified departments.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified departments.\n\nSource reference: https://developer.avionte.com/reference/query-multiple-departments.md", "operationId": "QueryMultipleDepartments", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of department IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A list of departments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfDepartment" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/query-multiple-departments.md", "x-original-operationId": "Query Multiple Departments" } }, "/front-office/v1/job/skills/multi-query": { "post": { "tags": [ "Jobs" ], "summary": "Query Multiple Jobs Skills", "description": "Returns details about the skills for the specified jobs.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the skills for the specified jobs.\n\nSource reference: https://developer.avionte.com/reference/query-multiple-jobs-skills.md", "operationId": "QueryMultipleJobsSkills", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of job IDs for which to retrieve skill details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 183494, 184800, 178458 ] } }, "required": true }, "responses": { "200": { "description": "A list of job skills.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJobSkill" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/query-multiple-jobs-skills.md", "x-original-operationId": "Query Multiple Jobs Skills" } }, "/front-office/v1/companies/multi-query": { "post": { "tags": [ "Companies" ], "summary": "Query Multiple Companies", "description": "Returns details about the specified companies.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified companies.\n\nSource reference: https://developer.avionte.com/reference/querymultiplecompanies.md", "operationId": "QueryMultipleCompanies", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of company IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 138492, 181744, 287748 ] } }, "required": true }, "responses": { "200": { "description": "A list of company details for the specified company IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfCompany" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultiplecompanies.md" } }, "/front-office/v1/contacts/multi-query": { "post": { "tags": [ "Contacts" ], "summary": "Query Multiple Contacts", "description": "Returns details about the specified contacts.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified contacts.\n\nSource reference: https://developer.avionte.com/reference/querymultiplecontacts.md", "operationId": "QueryMultipleContacts", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of contact IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A list of contacts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfContact" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultiplecontacts.md" } }, "/front-office/v1/placements/multi-query": { "post": { "tags": [ "Placements" ], "summary": "Query Multiple Placements", "description": "Returns details about the specified placements.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified placements.\n\nSource reference: https://developer.avionte.com/reference/querymultiplehires.md", "operationId": "QueryMultipleHires", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of placement IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 12345, 67890, 13579 ] } }, "required": true }, "responses": { "200": { "description": "The placements for the specified IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfPlacement" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultiplehires.md" } }, "/front-office/v1/jobs/multi-query": { "post": { "tags": [ "Jobs" ], "summary": "Query Multiple Jobs", "description": "Returns details about the specified jobs.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified jobs.\n\nSource reference: https://developer.avionte.com/reference/querymultiplejobs.md", "operationId": "QueryMultipleJobs", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of job IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 1384921, 1817442, 2877482 ] } }, "required": true }, "responses": { "200": { "description": "The the list of jobs that were successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfJob" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultiplejobs.md" } }, "/front-office/v1/talent/stage/multi-query": { "post": { "tags": [ "Talent" ], "summary": "Query Multiple Nomination Stages", "description": "Returns details about the specified talent nomination stages.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified talent nomination stages.\n\nSource reference: https://developer.avionte.com/reference/querymultiplestages.md", "operationId": "QueryMultipleStages", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of talent nomination stage IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 42280, 184773, 148722 ] } }, "required": true }, "responses": { "200": { "description": "A list of talent nomination stages for the specified IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentStage" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultiplestages.md" } }, "/front-office/v1/talents/multi-query": { "post": { "tags": [ "Talent" ], "summary": "Query Multiple Talents", "description": "Returns details about the specified talent records.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified talent records.\n\nSource reference: https://developer.avionte.com/reference/querymultipletalents.md", "operationId": "QueryMultipleTalents", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of talent IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A list of talent records.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalent" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultipletalents.md" } }, "/front-office/v1/talents/home-office-employer": { "post": { "tags": [ "Talent" ], "summary": "Get Talents Home Office Employer", "description": "Returns a list of talent ID and their corresponding home office Employer ID.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of talent ID and their corresponding home office Employer ID.\n\nSource reference: https://developer.avionte.com/reference/querymultipletalentshomeofficeemployer.md", "operationId": "QueryMultipleTalentsHomeOfficeEmployer", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of talent IDs for which home office employer IDs are being queried.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 123345, 456624, 789634 ] } }, "required": true }, "responses": { "200": { "description": "A list of talent IDs and their corresponding home office employer IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentHomeOfficeEmployer" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultipletalentshomeofficeemployer.md" } }, "/front-office/v1/talent/skill/multi-query": { "post": { "tags": [ "Talent" ], "summary": "Query Multiple Talent Skills", "description": "Returns details about the skills for the specified talent records.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the skills for the specified talent records.\n\nSource reference: https://developer.avionte.com/reference/querymultipletalentskills.md", "operationId": "QueryMultipleTalentSkills", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of talent IDs for which to retrieve skills.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A list of talent skills.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentSkill" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultipletalentskills.md" } }, "/front-office/v1/users/hcm/multi-query": { "post": { "tags": [ "Users" ], "summary": "Query Multiple HCM Users", "description": "Returns details about the specified HCM users.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified HCM users.\n\nSource reference: https://developer.avionte.com/reference/querymultipleusers.md", "operationId": "QueryMultipleUsers", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of HCM user IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A list of HCM users.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfApiUser" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultipleusers.md" } }, "/front-office/v1/users/multi-query": { "post": { "tags": [ "Users" ], "summary": "Query Multiple Users", "description": "Returns details about the specified users.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about the specified users.\n\nSource reference: https://developer.avionte.com/reference/querymultipleusers2.md", "operationId": "QueryMultipleUsers2", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of user IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "The users that were successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfApiUser" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultipleusers2.md" } }, "/front-office/v1/users/office/multi-query": { "post": { "tags": [ "Users" ], "summary": "Query Multiple Users Offices", "description": "Returns office IDs for the specified users.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns office IDs for the specified users.\n\nSource reference: https://developer.avionte.com/reference/querymultipleusersoffices.md", "operationId": "QueryMultipleUsersOffices", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of user IDs for which to retrieve office IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A list of offices for the specified users.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfUserOffices" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultipleusersoffices.md" } }, "/front-office/v1/webapplicants/job/multi-query": { "post": { "tags": [ "Web Applicants" ], "summary": "Query Multiple Web Applicants", "description": "Returns details about web applicants for the specified jobs.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns details about web applicants for the specified jobs.\n\nSource reference: https://developer.avionte.com/reference/querymultiplewebapplicants.md", "operationId": "QueryMultipleWebApplicants", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "An array of web applicant IDs for which to retrieve details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } }, "required": true }, "responses": { "200": { "description": "A list of web applicants.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfApiMultiWebApplicants" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/querymultiplewebapplicants.md" } }, "/front-office/v1/job/{jobId}/skills/remove": { "post": { "tags": [ "Jobs" ], "summary": "Remove Job Skills", "description": "Removes existing job skills for a particular job. Skills are displayed in the *Position Categories and Skill Set* section of the job profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRemoves existing job skills for a particular job. Skills are displayed in the *Position Categories and Skill Set* section of the job profile page.\n\nSource reference: https://developer.avionte.com/reference/remove-job-skills.md", "operationId": "RemoveJobSkills", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "jobId", "in": "path", "description": "The identifier for the job from which the skills are being removed.", "required": true, "schema": { "type": "string" }, "example": "1788427" } ], "requestBody": { "description": "An array of job skill IDs to be removed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 184389, 178899, 284828 ] } }, "required": true }, "responses": { "201": { "description": "The results of the job skill removal.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__JobSkillResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/remove-job-skills.md", "x-original-operationId": "Remove Job Skills" } }, "/bo-prod/v3/{entityType}/{entityId}/extras/{extraValueId}": { "delete": { "tags": [ "Extra Value (Custom Field)" ], "summary": "Remove Extra Value by Entity Type and ID", "description": "Removes an extra value (custom field) from the specified entity.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-02T19:20:34.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRemoves an extra value (custom field) from the specified entity.\n\nSource reference: https://developer.avionte.com/reference/removeextravaluebyentitytypeandid.md", "operationId": "RemoveExtraValueByEntityTypeAndId", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "entityType", "in": "path", "description": "The Back Office entity type.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "Talent" }, { "name": "entityId", "in": "path", "description": "The identifier for the endtity.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__BackOfficeIdentifierId" }, "example": 29305 }, { "name": "extraValueId", "in": "path", "description": "The identifier for the extra value (custom field).", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__BackOfficeIdentifierId" }, "example": 4567 } ], "responses": { "204": { "description": "Record deleted successfully." }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "ExtraValueController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removeextravaluebyentitytypeandid.md" }, "patch": { "tags": [ "Extra Value (Custom Field)" ], "summary": "Update Extra Value by Entity Type and ID", "description": "Updates an extra value (custom field) for the specified entity.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-02T19:20:34.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates an extra value (custom field) for the specified entity.\n\nSource reference: https://developer.avionte.com/reference/updateextravaluebyentitytypeandid.md", "operationId": "UpdateExtraValueByEntityTypeAndId", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": false, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "entityType", "in": "path", "description": "The Back Office entity type.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "Talent" }, { "name": "entityId", "in": "path", "description": "The identifier for the entity.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__BackOfficeIdentifierId" }, "example": 29305 }, { "name": "extraValueId", "in": "path", "description": "The identifier for the Extra value.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__BackOfficeIdentifierId" }, "example": 4567 } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ArrayOfPatchOperations" }, "examples": { "Example 1": { "value": [ { "op": "replace", "path": "/extraValueOptionValue", "value": "Day Shift" }, { "op": "replace", "path": "/customSetupOptionId", "value": 102 } ] } } } } }, "responses": { "200": { "$ref": "#/components/responses/bo_prod__ExtraValuePatchResponse" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "ExtraValueController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updateextravaluebyentitytypeandid.md" } }, "/front-office/v1/talent/{talentId}/direct-deposit-accounts/{id}": { "delete": { "tags": [ "Talent" ], "summary": "Archive a Talent Direct Deposit Account", "description": "Archives the specified direct deposit account for the given talent. The account is soft-deleted and can be restored using the PATCH endpoint on the same path.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nArchives the specified direct deposit account for the given talent. The account is soft-deleted and can be restored using the PATCH endpoint on the same path.\n\nSource reference: https://developer.avionte.com/reference/removetalentdirectdepositaccount.md", "operationId": "RemoveTalentDirectDepositAccount", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose direct deposit account is being archived.", "required": true, "schema": { "type": "string" }, "example": "17844" }, { "name": "id", "in": "path", "description": "The identifier for the direct deposit account that is to be archived.", "required": true, "schema": { "type": "string" }, "example": "1356" } ], "responses": { "204": { "description": "The direct deposit account was successfully archived." }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removetalentdirectdepositaccount.md" } }, "/front-office/v1/talent-quick-title/{applicantId}/remove": { "delete": { "tags": [ "Talent" ], "summary": "Remove Talent Quick Title", "description": "Permanently deletes the specified quick search or custom category tag from the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes the specified quick search or custom category tag from the talent profile page.\n\nSource reference: https://developer.avionte.com/reference/removetalentquicktitle.md", "operationId": "RemoveTalentQuickTitle", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent for whom the Quick Search or Custom Category Tag is being deleted.", "required": true, "schema": { "type": "string" }, "example": "183482" }, { "name": "id", "in": "query", "description": "The identifier for the Quick Search or Custom Category Tag to be permanently deleted.", "required": true, "schema": { "type": "string" }, "example": "5824" } ], "responses": { "201": { "description": "The Quick Search or Custom Category Tag was successfully deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentQuickSearchTitle" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removetalentquicktitle.md" } }, "/front-office/v1/talent/{talentId}/talent-referrals/{referralId}": { "delete": { "tags": [ "Talent" ], "summary": "Remove Talent Referral", "description": "Removes a talent referral by the specified talent and/or for the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRemoves a talent referral by the specified talent and/or for the specified talent.\n\nSource reference: https://developer.avionte.com/reference/removetalentreferral.md", "operationId": "RemoveTalentReferral", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent record for which the referral should be removed.", "required": true, "schema": { "type": "string" }, "example": "17489" }, { "name": "referralId", "in": "path", "description": "The identifier for the referral record being removed.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The referrals for the talent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentReferrals" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removetalentreferral.md" } }, "/front-office/v1/talent/{talentId}/skills/remove": { "post": { "tags": [ "Talent" ], "summary": "Remove Talent Skills", "description": "Permanently deletes talent skills tags of the specified talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes talent skills tags of the specified talent record.\n\nSource reference: https://developer.avionte.com/reference/removetalentskills.md", "operationId": "RemoveTalentSkills", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "An identifier for the talent whose skills are to be removed.", "required": true, "schema": { "type": "string" }, "example": "117383" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfTalentSkill" } } }, "required": true }, "responses": { "201": { "description": "The results of the attempt to remove the specified talent skills.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentSkillResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removetalentskills.md" } }, "/front-office/v1/talent-source/{applicantId}/remove": { "delete": { "tags": [ "Talent" ], "summary": "Remove Talent Source", "description": "Permanently deletes a specified talent source tag from the specified talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nPermanently deletes a specified talent source tag from the specified talent profile page.\n\nSource reference: https://developer.avionte.com/reference/removetalentsource.md", "operationId": "RemoveTalentSource", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "applicantId", "in": "path", "description": "The identifier for the talent whose source tag is being removed.", "required": true, "schema": { "type": "string" }, "example": "174882" }, { "name": "id", "in": "query", "description": "The identifier for the Talent Source Tag to be removed.", "required": true, "schema": { "type": "string" }, "example": "28482" } ], "responses": { "201": { "description": "The removed talent source tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentSource" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removetalentsource.md" } }, "/front-office/v1/company-restrictions/remove-universal-restriction": { "delete": { "tags": [ "Companies" ], "summary": "Remove Universal Company Restriction", "description": "Removes a talent from the 'Do Not Assign' list universally across multiple tenants for specified companies.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRemoves a talent from the 'Do Not Assign' list universally across multiple tenants for specified companies.\n\nSource reference: https://developer.avionte.com/reference/removeuniversalcompanyrestriction.md", "operationId": "RemoveUniversalCompanyRestriction", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__UniversalCompanyRestrictionRequest" } } }, "required": true }, "responses": { "200": { "description": "A response indicating the success of the operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__UniversalCompanyRestrictionResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/removeuniversalcompanyrestriction.md" } }, "/front-office/v1/user/talent-user/auth0-create-in-progress": { "post": { "tags": [ "Users" ], "summary": "Set Auth0 Create User In Progress", "description": "Sets a flag on the Talent User record that signifies Auth0 user creation is in progress.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nSets a flag on the Talent User record that signifies Auth0 user creation is in progress.\n\nSource reference: https://developer.avionte.com/reference/settalentuserauth0createinprogress.md", "operationId": "SetTalentUserAuth0CreateInProgress", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentUserRequest" } } }, "required": true }, "responses": { "200": { "description": "The Talent User that was updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentUser" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/settalentuserauth0createinprogress.md" } }, "/front-office/v1/talent/stage/ids/{page}/{pageSize}": { "get": { "tags": [ "Talent" ], "summary": "Get Nomination Stage IDs", "description": "Returns a paged list of all stage IDs.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of all stage IDs.\n\nSource reference: https://developer.avionte.com/reference/stageids.md", "operationId": "StageIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "description": "The page number to retrieve in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "pageSize", "in": "path", "description": "The number of records to include per page in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "25" } ], "responses": { "200": { "description": "A paged list of nomination stage IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 1848945, 1674824, 1485992 ] } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/stageids.md" } }, "/front-office/v1/talents/ids/{page}/{pageSize}": { "get": { "tags": [ "Talent" ], "summary": "Get Talent IDs", "description": "Returns a paged list of talent IDs registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of talent IDs registered in the system.\n\nSource reference: https://developer.avionte.com/reference/talentids.md", "operationId": "TalentIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "description": "The page number to retrieve in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "pageSize", "in": "path", "description": "The number of records to include per page in a paginated response.", "required": true, "schema": { "type": "string" }, "example": "50" } ], "responses": { "200": { "description": "A paged list of talent IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" }, "example": [ 1848945, 1674824, 1485992 ] } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/talentids.md" } }, "/front-office/v1/placement/{placementId}/placement-schedules": { "get": { "tags": [ "Placements" ], "summary": "Get a List of Placement Schedules", "description": "Returns a list of placement schedules for the specified placement from the Schedule widget of the Hired Details aside. This endpoint is specific to Avionté 24/7.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a list of placement schedules for the specified placement from the Schedule widget of the Hired Details aside. This endpoint is specific to Avionté 24/7.\n\nSource reference: https://developer.avionte.com/reference/the-list-of-placement-schedules.md", "operationId": "TheListOfPlacementSchedules", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "placementId", "in": "path", "description": "The identifier for the placement whose schedules are being retrieved.", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "The placement ID and associated placement schedule shifts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PlacementSchedule" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/the-list-of-placement-schedules.md", "x-original-operationId": "The List of Placement Schedules" } }, "/front-office/v1/talent/{talentId}/everify/{caseNumber}": { "put": { "tags": [ "Talent" ], "summary": "Update an E-Verify Record", "description": "Updates information about the E-Verify record of the specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates information about the E-Verify record of the specified talent.\n\n> ⚠️\n>\n> When making a PUT request, make sure to include the entire object in the payload for successful updates.\n\nSource reference: https://developer.avionte.com/reference/update-everify-record.md", "operationId": "UpdateEverifyRecord", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent whose E-Verify case is being retrieved.", "required": true, "schema": { "type": "string" }, "example": "173833" }, { "name": "caseNumber", "in": "path", "description": "The case number of the E-Verify record to update.", "required": true, "schema": { "type": "string" }, "example": "2024179171735HB" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__EverifyDomainModel" } } }, "required": true }, "responses": { "200": { "description": "The updated E-Verify record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__EverifyDomainModel" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/update-everify-record.md", "x-original-operationId": "Update Everify Record" } }, "/bo-prod/v3/invoice/finance-charge": { "put": { "tags": [ "Invoices" ], "summary": "Update Invoice Finance Charge", "description": "Recalculates the finance charges for the specified invoices based on the invoice IDs provided in the request.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T17:13:27.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nRecalculates the finance charges for the specified invoices based on the invoice IDs provided in the request.\n\nSource reference: https://developer.avionte.com/reference/updateinvoicefinancecharge.md", "operationId": "UpdateInvoiceFinanceCharge", "parameters": [ { "name": "companyGuid", "in": "query", "description": "The unique identifier for a Company record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22" }, { "name": "companyExternalId", "in": "query", "description": "The external ID of the Company entity, used as an alternative to the __CompanyGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Company entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __CompanyGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 366992 }, { "name": "departmentExternalId", "in": "query", "description": "The unique identifier for a Department record, formatted as a UUID.", "schema": { "type": "string" }, "example": 458434 }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__arrayOfGuids" }, "responses": { "200": { "description": "Invoice updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__InvoiceArray" }, "examples": { "Example 1": { "value": [ { "invoiceId": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c", "invoiceNumber": "INV-100234", "invoiceDate": "2026-06-15", "billAmount": 5000, "invoiceAmount": 5250, "balanceAmount": 5250, "salesTaxAmount": 250, "discountTaxAmount": 0, "dueDate": "2026-07-15", "branchId": "17343e09-c780-462b-b566-e7258b2054d1", "paymentTermOptionId": 1, "isPosted": true, "billingBatchId": "a1f4c2e8-3b6d-4e9a-8c7f-1d2e3f4a5b6c", "invoiceToId": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22", "invoiceStyleId": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "invoiceTypeOptionId": 1, "totalFinanceChargeAmount": 25 } ] } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "InvoiceController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updateinvoicefinancecharge.md" } }, "/bo-prod/v3/invoice/invoice-style": { "patch": { "tags": [ "Invoices" ], "summary": "Update Invoice Style", "description": "Updates the invoice style for one or more invoices.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-06-29T17:13:27.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the invoice style for one or more invoices.\n\nSource reference: https://developer.avionte.com/reference/updateinvoicestyle.md", "operationId": "UpdateInvoiceStyle", "parameters": [ { "name": "companyGuid", "in": "query", "description": "The unique identifier for a Company record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22" }, { "name": "companyExternalId", "in": "query", "description": "The external ID of the Company entity, used as an alternative to the __CompanyGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Company entity record. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __CompanyGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 366992 }, { "name": "departmentExternalId", "in": "query", "description": "The unique identifier for a Department record, formatted as a UUID.", "schema": { "type": "string" }, "example": 458434 }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__InvoiceStylePatchBody" }, "responses": { "200": { "description": "Record modified successfully." }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "InvoiceController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updateinvoicestyle.md" } }, "/front-office/v1/talent/{talentId}/partner-task/{taskId}/status": { "post": { "tags": [ "Talent" ], "summary": "Update Partner Task Status", "description": "Updates the status of a partner task assigned to a talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-08-05T19:11:15.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the status of a partner task assigned to a talent.\n\nSource reference: https://developer.avionte.com/reference/updatepartnertaskstatus.md", "operationId": "UpdatePartnerTaskStatus", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier of the talent.", "required": true, "schema": { "type": "string" }, "example": "17847" }, { "name": "taskId", "in": "path", "description": "The identifier of the partner task.", "required": true, "schema": { "type": "string" }, "example": "98765" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PartnerTaskStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "The updated partner task status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PartnerTaskStatusResponse" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatepartnertaskstatus.md" } }, "/back-office/v1/talent-benefit/{talentGuid}/{transactionTypeId}/update-benefit-contribution": { "patch": { "tags": [ "TalentBenefits", "Talent" ], "summary": "Update Talent Benefit Contribution", "description": "Updates a talent benefit contribution for a specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates a talent benefit contribution for a specified talent.\n\nSource reference: https://developer.avionte.com/reference/updatetalentbenefitcontribution.md", "operationId": "UpdateTalentBenefitContribution", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "supplierGuid", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "description": "The unique identifier for the supplier (employer) record, formatted as a GUID." } }, { "name": "talentGuid", "in": "path", "description": "The unique identifier for the talent, formatted as a GUID.", "required": true, "schema": { "type": "string" } }, { "name": "transactionTypeId", "in": "path", "description": "The unique identifier for the talent benefit transaction type.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfPatchOperations" }, "example": [ { "path": "/benefitPayrollContribution/contributionAmount", "op": "replace", "value": "10.29" }, { "path": "/benefitPayrollContribution/contributionEndDate", "op": "remove" } ] } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentBenefitContribution" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatetalentbenefitcontribution.md" } }, "/back-office/v1/talent-benefit/{talentGuid}/{transactionTypeId}/update-benefit-deduction": { "patch": { "tags": [ "TalentBenefits", "Talent" ], "summary": "Update Talent Benefit Deduction", "description": "Updates a talent benefit deduction for a specified talent.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates a talent benefit deduction for a specified talent.\n\nSource reference: https://developer.avionte.com/reference/updatetalentbenefitdeduction.md", "operationId": "UpdateTalentBenefitDeduction", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for.", "required": true, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "supplierGuid", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "description": "The unique identifier for the supplier (employer) record, formatted as a GUID." } }, { "name": "talentGuid", "in": "path", "description": "The unique identifier for the talent, formatted as a GUID.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "transactionTypeId", "in": "path", "description": "The unique identifier for the talent benefit transaction type.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfPatchOperations" }, "example": [ { "path": "/benefitPayrollDeduction/deductionAmount", "op": "replace", "value": "10.29" }, { "path": "/benefitPayrollDeduction/deductionEndDate", "op": "remove" } ] } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentBenefitDeduction" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatetalentbenefitdeduction.md" } }, "/back-office/v1/talent-benefit/{talentGuid}/{transactionTypeId}/updateBenefit": { "patch": { "tags": [ "TalentBenefits", "Talent" ], "summary": "Update Talent Benefit Enrollment (Deprecated)", "description": "Updates a talent benefit enrollment for a given talent. (Deprecated, use /v1/talent-benefit/{talentGuid}/{transactionTypeId}/update-benefit-deduction)\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-29T16:51:04.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates a talent benefit enrollment for a given talent. (Deprecated, use /v1/talent-benefit/{talentGuid}/{transactionTypeId}/update-benefit-deduction)\n\nSource reference: https://developer.avionte.com/reference/updatetalentbenefitenrollment.md", "operationId": "UpdateTalentBenefitEnrollment", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code for scoped data access during the request.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" }, { "name": "supplierGuid", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "description": "The unique identifier for the supplier (employer) record, formatted as a GUID." } }, { "name": "talentGuid", "in": "path", "description": "The unique identifier for the talent, formatted as a GUID.", "required": true, "schema": { "type": "string" } }, { "name": "transactionTypeId", "in": "path", "description": "The unique identifier for the talent benefit transaction type.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfPatchOperations" }, "example": [ { "path": "/benefitPayrollDeduction/deductionAmount", "op": "replace", "value": "10.29" }, { "path": "/benefitPayrollDeduction/deductionEndDate", "op": "remove" } ] } }, "required": true }, "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentBenefitDeduction" } } } }, "400": { "$ref": "#/components/responses/back_office__error400" }, "401": { "$ref": "#/components/responses/back_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/back_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/back_office__404NotFound" }, "406": { "$ref": "#/components/responses/back_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/back_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/back_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/back_office__500InternalError" }, "502": { "$ref": "#/components/responses/back_office__502BadGateway" } }, "deprecated": true, "security": [ { "back_office__security_key_header": [] }, { "back_office__bearerHttpAuthentication": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatetalentbenefitenrollment.md" } }, "/bo-prod/v3/talent/check-delivery": { "put": { "tags": [ "Taxes" ], "summary": "Update Talent Check Delivery Setup", "description": "Updates the check delivery custom setup option for the talent record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-15T13:07:53.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the check delivery custom setup option for the talent record.\n\nSource reference: https://developer.avionte.com/reference/updatetalentcheckdelivery.md", "operationId": "UpdateTalentCheckDelivery", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" } ], "requestBody": { "$ref": "#/components/requestBodies/bo_prod__UpdateCheckDeliveryPutBody" }, "responses": { "200": { "description": "Check delivery updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__Talent" }, "examples": { "Example 1": { "value": { "talentGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "branchGuid": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c", "backOfficeEmployeeId": 5567, "firstName": "Jane", "middleName": "A", "lastName": "Smith", "residentAddress": { "addressGuid": "83db44f4-daee-496d-ba89-c3ed98de057d", "street1": "123 Main St", "street2": "Apt 4", "city": "Minneapolis", "postalCode": "55401", "state": "MN", "country": "US" }, "taxIdNumber": "111-11-1111", "dateOfBirth": "1990-05-05T00:00:00Z", "mobilePhone": "555-123-4567", "emailAddress": "jane.smith@example.com", "gender": "F", "checkDeliveryOptionId": 42 } } } } } }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatetalentcheckdelivery.md" } }, "/front-office/v1/pipeline/talent-stage/{pipelineId}": { "put": { "tags": [ "Talent", "Jobs" ], "summary": "Update a Talent Pipeline Stage", "description": "Updates a talent to a pipeline stage for a job.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-05-01T15:08:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates a talent to a pipeline stage for a job.\n\nSource reference: https://developer.avionte.com/reference/updatetalentpipelinestage.md", "operationId": "UpdateTalentPipeLineStage", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "pipelineId", "in": "path", "description": "The identifier for the pipeline.", "required": true, "schema": { "type": "string" }, "example": "1847292" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PipelineTalentStageUpdate" } } }, "required": true }, "responses": { "200": { "description": "The talent pipeline stage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__PipelineTalentStageUpdate" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatetalentpipelinestage.md" } }, "/bo-prod/v3/talent/update-tax": { "patch": { "tags": [ "Taxes" ], "summary": "Update Talent Tax", "description": "Updates the setup of the specified talent's tax record.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-15T13:08:02.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUpdates the setup of the specified talent's tax record.\n\nSource reference: https://developer.avionte.com/reference/updatetalenttax.md", "operationId": "UpdateTalentTax", "parameters": [ { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "RequestOrigin", "in": "header", "description": "The string source name (such as application or function name) that indicates the origin of the request.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" }, "example": "BOLD" }, { "name": "RequestId", "in": "header", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, { "name": "ExternalIdSource", "in": "header", "description": "The external ID source that determines which external reference source is used to perform an external ID lookup.", "required": true, "schema": { "type": "string", "enum": [ "BOLD" ] }, "example": "BOLD" }, { "name": "talentGuid", "in": "query", "description": "The unique identifier of a Talent record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "talentExternalId", "in": "query", "description": "The external ID of the Talent entity, used as an alternative to the __TalentGuid__ query parameter. When provided with a valid __ExternalIdSource__ header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an __ExternalEntityNotFound__ error is returned. If a match is found, the response includes a __TalentGuid__ header containing the classic entity record ID.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": 2161216 }, { "name": "RequestUserExternalId", "in": "header", "description": "The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.", "required": true, "schema": { "type": "string" }, "example": "ABC123" }, { "name": "federalW4Id", "in": "query", "description": "The unique identifier for a federal W-4 tax record.", "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "employeeTaxGuid", "in": "query", "description": "The unique identifier for a talent tax record, formatted as a UUID.", "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ArrayOfPatchOperations" }, "examples": { "Example 1": { "value": [ { "op": "replace", "path": "/taxFilingStatusId", "value": 2 }, { "op": "replace", "path": "/exemptions", "value": 1 }, { "op": "replace", "path": "/additionalWithholding", "value": 25 } ] } } } } }, "responses": { "200": { "description": "Record modified successfully." }, "400": { "$ref": "#/components/responses/bo_prod__apiResultFailure400" }, "402": { "$ref": "#/components/responses/bo_prod__402BackOfficeSubscriptionRequired" }, "403": { "$ref": "#/components/responses/bo_prod__apiResultInsufficientPermissions403" }, "404": { "$ref": "#/components/responses/bo_prod__apiResultNotFound404" }, "405": { "$ref": "#/components/responses/bo_prod__405UnsupportedMethod" }, "415": { "$ref": "#/components/responses/bo_prod__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/bo_prod__429TooManyRequests" }, "500": { "$ref": "#/components/responses/bo_prod__500InternalError" }, "502": { "$ref": "#/components/responses/bo_prod__502BadGateway" }, "504": { "$ref": "#/components/responses/bo_prod__504GatewayTimeout" } }, "x-swagger-router-controller": "TalentTaxController", "security": [ { "bo_prod__gatewayApiKey": [] }, { "bo_prod__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/updatetalenttax.md" } }, "/front-office/v1/talent/{talentId}/upload-document": { "post": { "tags": [ "Talent" ], "summary": "Upload a Document", "description": "Uploads a document to the profile page of the specified talent record. Uploaded document displays on the *Documents* tab of the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUploads a document to the profile page of the specified talent record. Uploaded document displays on the *Documents* tab of the talent profile page.\n\n> ⚠️\n>\n> Although the **Id** parameter is listed among the body parameters, it does not need to be specified. The entered value will be overwritten.\n\n> ⚠️\n>\n> The file size limit for uploaded files is 2GB.\n\nSource reference: https://developer.avionte.com/reference/upload-document.md", "operationId": "UploadDocument", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent.", "required": true, "schema": { "type": "string" }, "example": "17837" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/front_office__MODELd09243" } } }, "required": true }, "responses": { "201": { "description": "The talent document that was successfully uploaded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentDocument" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/upload-document.md", "x-original-operationId": "Upload Document" } }, "/front-office/v1/talent/{talentId}/upload-document-from-body": { "post": { "tags": [ "Talent" ], "summary": "Upload a Document from Request Body", "description": "Uploads a document provided in the request body to the profile page of the specified talent record. Uploaded document displays on the *Documents* tab of the talent profile page.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUploads a document provided in the request body to the profile page of the specified talent record. Uploaded document displays on the *Documents* tab of the talent profile page.\n\nSource reference: https://developer.avionte.com/reference/upload-document-from-body.md", "operationId": "UploadDocumentFromBody", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "talentId", "in": "path", "description": "The identifier for the talent for whom the document is being uploaded.", "required": true, "schema": { "type": "string" }, "example": "17849" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentDocumentFromBody" } } }, "required": true }, "responses": { "201": { "description": "The document that was successfully uploaded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__TalentDocumentFromBody" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/upload-document-from-body.md", "x-original-operationId": "Upload Document From Body" } }, "/front-office/v1/job/{jobId}/upload-document": { "post": { "tags": [ "Jobs" ], "summary": "Upload a Document to Job", "description": "Uploads the provided document to the job.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nUploads the provided document to the job.\n\n> ⚠️\n>\n> The file size limit for uploaded files is 2GB.\n\nSource reference: https://developer.avionte.com/reference/upload-document-to-job.md", "operationId": "UploadDocumentToJob", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "jobId", "in": "path", "description": "The unique identifier of the job to which the document will be uploaded.", "required": true, "schema": { "type": "string" }, "example": "184762" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__JobDocumentDTO" } } }, "required": true }, "responses": { "200": { "description": "The uploaded document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__JobDocumentDTO" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/upload-document-to-job.md", "x-original-operationId": "Upload Document to Job" } }, "/front-office/v1/timesheets/daily": { "put": { "tags": [ "Timesheets" ], "summary": "Update Daily TimeSheet", "description": "Creates or updates a daily timesheet entry for a specific placement and day. Supports daily hours and mobile punch time capture methods with multiple breaks per day.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-04-30T14:23:13.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nCreates or updates a daily timesheet entry for a specific placement and day. Supports daily hours and mobile punch time capture methods with multiple breaks per day.\n\nSource reference: https://developer.avionte.com/reference/upsertdailytimesheet.md", "operationId": "UpsertDailyTimeSheet", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" } ], "requestBody": { "description": "Represents a daily timesheet entry for single-day timesheet find-or-create operations.\nSupports daily hours and mobile punch time capture methods with multiple breaks per day.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DailyTimeSheetDto" } } }, "required": true }, "responses": { "200": { "description": "The daily timesheet entry that was successfully created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__DailyTimeSheetResponseDto" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "409": { "$ref": "#/components/responses/front_office__409Conflict" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/upsertdailytimesheet.md" } }, "/front-office/v1/users/ids/{page}/{pageSize}": { "get": { "tags": [ "Users" ], "summary": "Get HCM User IDs", "description": "Returns a paged list of HCM user IDs registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of HCM user IDs registered in the system.\n\nSource reference: https://developer.avionte.com/reference/userids.md", "operationId": "UserIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A paged list of user IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/userids.md" } }, "/front-office/v1/users/user-type/ids/{userType}/{page}/{pageSize}": { "get": { "tags": [ "Users" ], "summary": "Get User IDs by User Type", "description": "Returns a paged list of user IDs, for the specified user type, registered in the system.\n\nAdditional reference notes:\n\n---\nupdatedAt: 2026-07-28T14:56:49.000Z\n---\n\nFetch the complete documentation index at: https://developer.avionte.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.\n\nReturns a paged list of user IDs, for the specified user type, registered in the system.\n\nSource reference: https://developer.avionte.com/reference/usertypeids.md", "operationId": "UserTypeIds", "parameters": [ { "name": "RequestId", "in": "header", "description": "Unique request identifier (UUID) used to correlate request data with log entries and events.", "required": false, "schema": { "$ref": "#/components/schemas/front_office__RequestId" } }, { "name": "FrontOfficeTenantId", "in": "header", "description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.", "required": false, "schema": { "type": "integer" }, "example": 89 }, { "name": "Tenant", "in": "header", "description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.", "required": false, "schema": { "type": "string" }, "example": "API_TEST" }, { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userType", "in": "path", "description": "The name of the user type. Available options are Talent, Manager, HCM, or All.", "required": true, "schema": { "type": "string" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A list of User IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/front_office__ArrayOfIntegerSchema" } } } }, "400": { "$ref": "#/components/responses/front_office__400BadRequest" }, "401": { "$ref": "#/components/responses/front_office__401Unauthorized" }, "403": { "$ref": "#/components/responses/front_office__403AccessDenied" }, "404": { "$ref": "#/components/responses/front_office__404NotFound" }, "405": { "$ref": "#/components/responses/front_office__405UnsupportedMethod" }, "406": { "$ref": "#/components/responses/front_office__406UnsupportedAccessHeader" }, "415": { "$ref": "#/components/responses/front_office__415UnsupportedContentType" }, "429": { "$ref": "#/components/responses/front_office__429TooManyRequests" }, "500": { "$ref": "#/components/responses/front_office__500InternalError" }, "502": { "$ref": "#/components/responses/front_office__502BadGateway" }, "504": { "$ref": "#/components/responses/front_office__504GatewayTimeout" } }, "security": [ { "front_office__api_key": [] }, { "front_office__bearerTokenAuth": [] } ], "x-reference-page": "https://developer.avionte.com/reference/usertypeids.md" } } }, "components": { "schemas": { "front_office__RequestId": { "type": "string", "description": "Unique request identifier in UUID format used to correlate request data to log entries and events.", "format": "uuid", "example": "63680b86-c7e0-4a36-ae4a-d0d481089aff" }, "front_office__CompanyCategoryTag": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Company Category Tag.", "format": "int32", "example": 293 }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 12345 }, "companyCategoryId": { "type": "integer", "description": "The identifier for the Company Category option.", "format": "int32", "example": 4567 }, "companyCategoryName": { "maxLength": 255, "type": "string", "description": "The name of the Company Category option.", "example": "Manufacturing" }, "companyCategoryDetail": { "maxLength": 255, "type": "string", "description": "The value for the Company Category detail.", "example": "Automotive" } }, "additionalProperties": false }, "front_office__Tag": { "type": "object", "properties": { "tagId": { "type": "integer", "description": "The identifier for the tag.", "format": "int32", "example": 12345 }, "tagName": { "maxLength": 255, "type": "string", "description": "The name of the tag.", "example": "Hospitality" } }, "additionalProperties": false }, "front_office__CompanyTag": { "allOf": [ { "$ref": "#/components/schemas/front_office__Tag" }, { "type": "object", "properties": { "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 17845 } }, "additionalProperties": false } ] }, "front_office__ContactCategoryTag": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Position Category Tag for the contact.", "format": "int32" }, "contactId": { "type": "integer", "description": "The identifier for the contact.", "format": "int32" }, "skillDescriptionId": { "type": "integer", "description": "The identifier for the skill description option.", "format": "int32" }, "skillDescription": { "type": "string", "description": "The name of the skill description option." }, "skillPositionId": { "type": "integer", "description": "The identifier for the skill position option.", "format": "int32" }, "skillPosition": { "type": "string", "description": "The name of the skill position option." } }, "additionalProperties": false }, "front_office__EverifyStatus": { "type": "string", "description": "The everify statuses available for selection.", "enum": [ "Draft", "UnconfirmedData", "Photo", "ScanAndUpload", "ManualReview", "PendingReferral", "Referred", "Queued", "EmploymentAuthorized", "FinalNonConfirmation", "CloseCaseAndResubmit", "Closed", "UnableToProcess" ] }, "front_office__EverifyDomainModel": { "type": "object", "properties": { "applicantId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 19485 }, "caseNumber": { "maxLength": 20, "type": "string", "description": "The number of the E-Verify case.", "example": "2024179171735HB" }, "submittedDate": { "type": "string", "description": "The date the case was submitted. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "caseStatus": { "description": "Information about the case status.", "oneOf": [ { "$ref": "#/components/schemas/front_office__EverifyStatus" } ] }, "isClosed": { "type": "boolean", "description": "An indication of whether the case is closed or not.", "example": true }, "isAuthorized": { "type": "boolean", "description": "An indication of whether the case is authorized or not.", "example": true }, "everifyURL": { "maxLength": 250, "type": "string", "description": "The URL to the E-Verify case." }, "source": { "maxLength": 250, "type": "string", "description": "The company or service that is handling the E-Verify case.", "example": "Equifax" }, "caseSubmittedByUser": { "type": "integer", "description": "The identifier for the user who submitted the case.", "format": "int32", "example": 13899 }, "applicantTaskId": { "type": "integer", "description": "The identifier for the talent onboarding task related to the E-Verify case.", "format": "int32", "example": 27852 }, "lastEventDateTimeUtc": { "type": "string", "description": "The event UTC timestamp passed in by the partner, in the format \"yyyy-MM-ddTHH:mm:ssZ\". For example, 2024-12-01T14:30:00Z.", "format": "date-time", "example": "2024-12-01T14:30:00Z" } }, "additionalProperties": false }, "front_office__JobSkill": { "required": [ "jobId" ], "type": "object", "properties": { "jobSkillId": { "type": "integer", "description": "The identifier for the job skill.", "format": "int32", "example": 184928 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 1578224 }, "descriptionId": { "type": "integer", "description": "The identifier for the skill description option.", "format": "int32", "example": 7735 }, "positionId": { "type": "integer", "description": "The identifier for the skill position option.", "format": "int32", "example": 643 }, "skillDescription": { "maxLength": 255, "type": "string", "description": "The skill description option.", "example": "Data Entry" }, "skillPosition": { "maxLength": 100, "type": "string", "description": "The skill position option.", "example": "Clerical" }, "skillTalentFacing": { "type": "boolean", "description": "An indication of whether a skill is visible and applicable to talent users.", "readOnly": true, "example": true } }, "additionalProperties": false }, "front_office__JobSkillResponse": { "type": "object", "properties": { "jobSkills": { "type": "array", "description": "A list of job skills and their details.", "items": { "type": "object", "description": "front_office__JobSkill (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "errors": { "type": "array", "description": "A list of validation errors generated while attempting to modify the skills associated with a job.", "items": { "type": "string" } } }, "additionalProperties": false }, "front_office__ArrayOfJobSkill": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__JobSkill" } }, "front_office__PlacementDto": { "required": [ "billRates", "createdDate", "enteredByUserId", "jobId", "origin", "payRates", "startDate", "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the placement.", "format": "int32", "example": 123456 }, "talentId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 189482 }, "jobId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 175529 }, "extensionId": { "type": "integer", "description": "The optional identifier for the placement extension.", "format": "int32", "example": 98765 }, "startDate": { "minLength": 1, "type": "string", "description": "The placement start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "endDate": { "type": "string", "description": "The placement end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "payRates": { "description": "Information about the pay rates.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Rate" } ] }, "billRates": { "description": "Information about the bill rates.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Rate" } ] }, "commissionUsers": { "type": "array", "description": "A list of commission recipients and their details.", "items": { "$ref": "#/components/schemas/front_office__CommissionUserDto" } }, "frontOfficeId": { "type": "integer", "description": "The identifier for the placement's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.", "format": "int32", "example": 12353 }, "payBasis": { "maxLength": 255, "type": "string", "description": "The pay basis for the placement. Valid values are Commission, Day, Hourly, Hybrid/Other, Piece Pay, Salary, Shift, and Weekly.", "example": "Hourly" }, "hiredDate": { "type": "string", "description": "The date the talent was hired. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "placementAdditionalRates": { "type": "array", "description": "A list of additional rates and their details.", "items": { "type": "object", "description": "front_office__PlacementAdditionalRatesDto (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "endReasonId": { "type": "integer", "description": "The identifier for the end reason.", "format": "int32", "example": 321 }, "endReason": { "maxLength": 500, "type": "string", "description": "The reason for ending the placement.", "example": "Project completed successfully" }, "recruiterUserId": { "type": "integer", "description": "The identifier for the recruiter user.", "format": "int32", "example": 24398 }, "recruiterUser": { "maxLength": 255, "type": "string", "description": "The email of the recruiter user.", "example": "john.doe@example.com" }, "enteredByUserId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The identifier for the user who created the placement.", "format": "int32", "example": 18925 }, "createdDate": { "minLength": 1, "type": "string", "description": "The date when the placement was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "hasNoEndDate": { "type": "boolean", "description": "An indication of whether the placement has an end date or not.", "example": false }, "originalStartDate": { "type": "string", "description": "The optional original start date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "finalEndDate": { "type": "string", "description": "The optional final end date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "origin": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The origin of the placement.", "example": "Acme Partner" }, "timeApproverIds": { "type": "array", "description": "List of identifiers for Time Approver users.", "example": [ 123456, 789012 ], "items": { "type": "integer", "format": "int32" } }, "placementScheduleShiftDtos": { "type": "array", "description": "The list of placement schedules shifts.", "items": { "type": "object", "description": "front_office__PlacementScheduleShiftDto (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "flsaClassification": { "type": "string", "description": "The Fair Labor Standards Act (FLSA) classification for the placement, which determines the talent's eligibility for overtime pay. Valid values are `Exempt`, `NonExempt`, and `None`.", "example": "Exempt", "enum": [ "Exempt", "NonExempt", "None" ] }, "workScheduleType": { "type": "string", "description": "The expected work schedule for the placement. Valid values are `Full-Time`, `Part-Time`, `Intermittent`, and `None`.", "example": "Full-Time", "enum": [ "Full-Time", "Part-Time", "Intermittent", "None" ] }, "remoteWork": { "type": "boolean", "description": "An indication of whether the placement is a remote work arrangement.", "example": false } }, "additionalProperties": false }, "front_office__PlacementScheduleShiftDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Job Hired Schedule Shift.", "format": "int32", "example": 123456 }, "jobScheduleShiftId": { "type": "integer", "description": "The identifier for the Job Schedule Shift.", "format": "int32", "example": 789012 }, "weekDay": { "type": "integer", "description": "The identifier for the shift weekday, starting with 0 for Sunday.", "format": "int32", "example": 1 }, "duration": { "type": "integer", "description": "The duration of the shift, in minutes.", "format": "int32", "example": 480 }, "startTime": { "type": "string", "description": "The start time of the shift, expressed in hours and minutes using 24-hour local time.", "format": "duration", "example": "08:00:00" }, "date": { "type": "string", "description": "The date for the shift. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "status": { "type": "string", "description": "The status of the placement schedule shift.", "example": "COMMITTED", "enum": [ "COMMITTED", "CANCELED" ] } }, "additionalProperties": false }, "front_office__CommissionUserDto": { "required": [ "commissionPercent", "commissionUserType", "userId" ], "type": "object", "properties": { "commissionUserType": { "maxLength": 500, "minLength": 1, "type": "string", "description": "The commission user type.", "example": "Recruiter" }, "userId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "User ID of the commission recipient.", "format": "int32", "example": 123456 }, "commissionPercent": { "maximum": 100, "minimum": 0.01, "type": "number", "description": "The commission percentage allocated to the recipient.", "format": "decimal", "example": 10 } }, "additionalProperties": false }, "front_office__PlacementApprover": { "type": "object", "properties": { "extensionId": { "type": "integer", "description": "The placement extension this approver record is attached to.", "format": "int32", "example": 901234 }, "approverUserId": { "type": "integer", "description": "The User id of the approver. Non-zero for both HCM User and Contact rows — every Contact used as an approver has a linked Manager User.", "format": "int32", "example": 78934 }, "approverEntityId": { "type": "integer", "description": "The approver's entity id. Equals approverUserId when approverEntityType = \"HCM User\"; equals the Contact record id when approverEntityType = \"Contact\". Always populated.", "format": "int32", "example": 78934 }, "approverEntityType": { "type": "string", "description": "Discriminator for the approver's entity.", "example": "HCM User", "enum": [ "HCM User", "Contact" ] }, "approverType": { "type": "string", "description": "What the approver approves.", "example": "Both", "enum": [ "Timesheets", "Expenses", "Both" ] } }, "additionalProperties": false, "description": "An approver attached to a placement extension. The approver may be an HCM User or a Contact." }, "front_office__Placement": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the placement.", "format": "int32", "example": 123456 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 789012 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 345678 }, "extensionId": { "type": "integer", "description": "The identifier for the current active placement extension.", "format": "int32", "example": 901234 }, "extensionIdList": { "type": "array", "description": "The list of identifiers for all of the placement extensions for the placement.", "example": [ 901234, 567890 ], "items": { "type": "integer", "format": "int32" } }, "startDate": { "type": "string", "description": "The placement start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "endDate": { "type": "string", "description": "The placement end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "isActive": { "type": "boolean", "description": "An indication of whether the placement is active or not.", "example": true }, "payRates": { "description": "Information about the pay rates.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Rate" } ] }, "billRates": { "description": "Information about the bill rates.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Rate" } ] }, "commissionUsers": { "type": "array", "description": "A list of commission recipients and their details.", "items": { "type": "object", "description": "front_office__CommissionUser (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "estimatedGrossProfit": { "type": "number", "description": "Estimated gross profit.", "format": "decimal", "example": 1500 }, "employmentType": { "description": "Information about the employment type.", "oneOf": [ { "$ref": "#/components/schemas/front_office__EmploymentType" } ] }, "frontOfficeId": { "type": "integer", "description": "The identifier for the placement's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.", "format": "int32", "example": 123 }, "isPermanentPlacementExtension": { "type": "boolean", "description": "An indication of whether the placement is permanent or not.", "example": false }, "payBasis": { "maxLength": 255, "type": "string", "description": "The pay basis for the placement.", "example": "Hourly" }, "hiredDate": { "type": "string", "description": "The date the talent was hired. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "placementAdditionalRates": { "type": "array", "description": "A list of additional rates and their details.", "items": { "type": "object", "description": "front_office__PlacementAdditionalRates (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "endReasonId": { "type": "integer", "description": "The identifier for the end reason.", "format": "int32", "example": 456 }, "endReason": { "maxLength": 500, "type": "string", "description": "The reason for ending the placement.", "example": "Contract completed" }, "enteredByUserId": { "type": "integer", "description": "The identifier for the user who entered the placement record.", "format": "int32", "example": 78934 }, "enteredByUser": { "maxLength": 255, "type": "string", "description": "The email of the user who entered the placement record.", "example": "john.doe@example.com" }, "recruiterUserId": { "type": "integer", "description": "The identifier for the recruiter user.", "format": "int32", "example": 12345 }, "recruiterUser": { "maxLength": 255, "type": "string", "description": "The email of the recruiter user.", "example": "john.doe@example.com" }, "customDetails": { "type": "array", "description": "A list of custom details.", "items": { "type": "object", "description": "front_office__PlacementDetail (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "createdByUserId": { "type": "integer", "description": "The identifier for the user who created the placement.", "format": "int32", "example": 67890 }, "createdDate": { "type": "string", "description": "The date when the placement was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "hasNoEndDate": { "type": "boolean", "description": "An indication of whether the placement has an end date or not.", "example": false }, "originalStartDate": { "type": "string", "description": "The original start date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "finalEndDate": { "type": "string", "description": "The final end date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "origin": { "maxLength": 50, "type": "string", "description": "The origin of the placement.", "example": "Partner XYZ" }, "reqEmploymentType": { "maxLength": 15, "type": "string", "description": "The employment type code for the placement.", "example": "1099" }, "reqEmploymentTypeName": { "maxLength": 50, "type": "string", "description": "The display name of the employment type for the placement.", "example": "1099 Contractor" }, "shiftName": { "maxLength": 255, "type": "string", "description": "Description of the configured job shift.", "example": "Day Shift" }, "placementScheduleShifts": { "type": "array", "description": "The Schedule Shifts for the placement. This property is specific to Avionté 24/7.", "items": { "type": "object", "description": "front_office__PlacementScheduleShift (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "placementScheduleDays": { "description": "The Schedule Shifts in days for the placement.", "oneOf": [ { "$ref": "#/components/schemas/front_office__PlacementScheduleDays" } ] }, "approvers": { "type": "array", "description": "The list of approvers attached to the placement across all extensions. Empty array when no approvers exist.", "items": { "type": "object", "description": "front_office__PlacementApprover (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "flsaClassification": { "type": "string", "description": "The Fair Labor Standards Act (FLSA) classification for the placement, which determins the talent's eligibility for overtime pay. Valid values are `Exempt`, `NonExempt`, and `None`.", "example": "Exempt", "enum": [ "Exempt", "NonExempt", "None" ] }, "workScheduleType": { "type": "string", "description": "The expected work schedule for the placement. Valid values are `Full-Time`, `Part-Time`, `Intermittent`, and `None`.", "example": "Full-Time", "enum": [ "Full-Time", "Part-Time", "Intermittent", "None" ] }, "remoteWork": { "type": "boolean", "description": "An indication of whether the placement is a remote work arrangement.", "example": false } }, "additionalProperties": false }, "front_office__PlacementScheduleShift": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the placement schedule shift.", "format": "int32", "example": 12345 }, "weekDay": { "type": "integer", "description": "The identifier for the shift weekday, starting with 0 for Sunday.", "format": "int32", "example": 1 }, "duration": { "type": "integer", "description": "The minutes for duration.", "format": "int32", "example": 480 }, "startTime": { "type": "string", "description": "Hours and minutes for start time in 24-hour local time.", "format": "duration", "example": "08:00:00" }, "date": { "type": "string", "description": "The date for the shift. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "createdDate": { "type": "string", "description": "The date when the placement was created. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "updatedDate": { "type": "string", "description": "The date when the placement was udpated. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "status": { "type": "string", "description": "The status of the placement schedule shift.", "example": "COMMITTED", "enum": [ "COMMITTED", "CANCELED" ] } }, "additionalProperties": false }, "front_office__PlacementAdditionalRatesDto": { "required": [ "leaveTypeID" ], "type": "object", "properties": { "leaveTypeID": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The identifier for the leave type or additional transaction type.", "format": "int32", "example": 123 }, "payRate": { "type": "number", "description": "The additional transaction pay rate value.", "format": "decimal", "example": 25 }, "billRate": { "type": "number", "description": "The additional transaction bill rate value.", "format": "decimal", "example": 30 }, "inputType": { "type": "string", "description": "The input type of the additional rate. Valid values are Hours, Punches and Units.", "example": "Hours" }, "payBillTerm": { "type": "integer", "description": "The identifier for the pay and bill term for the additional rate. Valid values are 1 for Paid & Billed and 2 for Paid NOT Billed.", "format": "int32", "example": 1 } }, "additionalProperties": false }, "front_office__ShiftScheduleDays": { "type": "object", "properties": { "monday": { "type": "boolean", "description": "An indication of whether Monday is part of a shift schedule or not.", "example": true }, "tuesday": { "type": "boolean", "description": "An indication of whether Tuesday is part of a shift schedule or not.", "example": true }, "wednesday": { "type": "boolean", "description": "An indication of whether Wednesday is part of a shift schedule or not.", "example": true }, "thursday": { "type": "boolean", "description": "An indication of whether Thursday is part of a shift schedule or not.", "example": true }, "friday": { "type": "boolean", "description": "An indication of whether Friday is part of a shift schedule or not.", "example": true }, "saturday": { "type": "boolean", "description": "An indication of whether Saturday is part of a shift schedule or not.", "example": false }, "sunday": { "type": "boolean", "description": "An indication of whether Sunday is part of a shift schedule or not.", "example": false } }, "additionalProperties": false }, "front_office__Rate": { "type": "object", "properties": { "regular": { "type": "number", "description": "The regular rate value.", "format": "decimal", "example": 15.5 }, "overtime": { "type": "number", "description": "The overtime rate value.", "format": "decimal", "example": 23.25 }, "doubletime": { "type": "number", "description": "The double time rate value.", "format": "decimal", "example": 31 } }, "additionalProperties": false }, "front_office__PlacementAdditionalRates": { "type": "object", "properties": { "leaveRuleId": { "type": "integer", "description": "The identifier for the leave rule.", "format": "int32", "example": 12345 }, "leaveTypeID": { "type": "integer", "description": "The identifier for the leave type or additional transaction type.", "format": "int32", "example": 6789 }, "payRate": { "type": "number", "description": "The additional transaction pay rate value.", "format": "decimal", "example": 20 }, "billRate": { "type": "number", "description": "The additional transaction bill rate value.", "format": "decimal", "example": 30 }, "inputType": { "maxLength": 50, "type": "string", "description": "The input type of the additional rate. Valid values are Hours, Punches and Units.", "example": "Hours" }, "payBillTerm": { "type": "integer", "description": "The identifier for the pay and bill term for the additional rate. Valid values are 1 for Paid & Billed and 2 for Paid NOT Billed.", "format": "int32", "example": 1 }, "leaveType": { "maxLength": 255, "type": "string", "description": "The leave or additional transaction type.", "example": "Sick Leave" } }, "additionalProperties": false }, "front_office__PlacementScheduleDays": { "type": "object", "properties": { "startTimeLocal": { "type": "string", "description": "The local start time for the shifts in a 24-hour format.", "example": "08:00:00" }, "endTimeLocal": { "type": "string", "description": "The local end time for the shifts in a 24-hour format.", "example": "17:00:00" }, "shiftScheduleDays": { "description": "Object that contains Shift Days.", "oneOf": [ { "$ref": "#/components/schemas/front_office__ShiftScheduleDays" } ] } }, "additionalProperties": false }, "front_office__CommissionUser": { "type": "object", "properties": { "commissionUserType": { "maximum": 500, "type": "string", "description": "The commission user type.", "example": "CommissionRecipient" }, "userId": { "type": "integer", "description": "User ID of the commission recipient.", "format": "int32", "example": 18394 }, "userFullName": { "type": "string", "description": "The full name of the commission recipient.", "example": "John Doe" }, "commissionPercent": { "type": "number", "description": "The commission percentage allocated to the recipient.", "format": "decimal", "example": 10.5 } }, "additionalProperties": false }, "front_office__EmploymentType": { "type": "string", "description": "Employment types available for selection.", "enum": [ "Temporary", "Permanent" ] }, "front_office__PlacementDetail": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the placement detail.", "format": "int32", "example": 123456 }, "placementId": { "type": "integer", "description": "The identifier for the placement.", "format": "int32", "example": 789012 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 345678 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 901234 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the detail.", "example": "Dress Code" }, "value": { "type": "string", "description": "The value of the detail. The format of the value depends on the type of detail. If the type is 'checkbox', the value can be 'Yes' or 'No'. If the type is 'minmax', the value can be a string representing the minimum value, like '10'. If the type is 'numeric', the value can be a number like '15'. If the type is 'time', the value can be a time string like '08:00'. If the type is 'text', the value can be a string like 'Business Casual'.", "example": "Business Casual" }, "additionalValue": { "maxLength": 255, "type": "string", "description": "An additional value needed for the detail. If the type is 'minmax', the value can be a string representing the maximum value, like '100'.", "example": "No jeans" }, "type": { "type": "string", "description": "The type of detail. The possible values are 'checkbox', 'minmax', 'numeric', 'text', 'time'.", "example": "text" } }, "additionalProperties": false }, "front_office__TalentEducationHistory": { "required": [ "degreeType", "schoolType", "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent education history record.", "format": "int32", "example": 1397 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 19884 }, "from": { "maxLength": 50, "type": "string", "description": "The start date. This is an open-format text field containing the year, and possibly month of the date. For example, 2012, 9/12, 09-2012.", "example": "9/2012" }, "to": { "maxLength": 50, "type": "string", "description": "The date of completion. This is an open-format text field containing the year, and possibly month of the date. For example, 2016, 5/16, 05-2016.", "example": "5/2016" }, "school": { "maxLength": 255, "type": "string", "description": "The name of the educational institution.", "example": "Kansas University" }, "schoolType": { "type": "string", "description": "The type of school attended. Valid values are 'Highschool', 'Secondary', 'Trade', 'Community', 'College' and 'University'.", "example": "College" }, "degree": { "maxLength": 255, "type": "string", "description": "The name of the obtained degree.", "example": "Bachelor's of Liberal Arts" }, "degreeType": { "type": "string", "description": "The type of the degree obtained.\nValid values are 'Secondary', 'High School or Equivalent', 'Some High School or Equivalent', 'HND/HNC or Equivalent', 'Vocational',\n 'Certification', 'Some College', 'Associates', 'Bachelors', 'Some Post-Graduate', 'Masters', 'Doctorate', 'Postdoctorate',\n 'Professional', 'Post Professional', 'Intermediate Graduate', 'Special Education', 'GED' and 'International'.", "example": "Bachelors" }, "field": { "maxLength": 500, "type": "string", "description": "The field of studies.", "example": "English" }, "gpa": { "maxLength": 255, "type": "string", "description": "The Grade Point Average.", "example": "3.56" }, "city": { "maxLength": 255, "type": "string", "description": "The city where the school is located.", "example": "Lawrence" }, "state": { "maxLength": 255, "type": "string", "description": "The state/province or region where the school is located in open-format text.", "example": "Kansas" }, "country": { "maxLength": 255, "type": "string", "description": "The country where the school is located in open-format text.", "example": "US" }, "notes": { "type": "string", "description": "Additional notes on the talent's education history.", "example": "Active in school government." } }, "additionalProperties": false }, "front_office__WebApplicantTestQuestion": { "type": "object", "properties": { "questionText": { "type": "string", "description": "The wording of the test question.", "example": "Years of experience?" }, "answers": { "description": "Information about the web applicant's answers.", "oneOf": [ { "$ref": "#/components/schemas/front_office__WebApplicantTestTalentAnswers" } ] } }, "additionalProperties": false }, "front_office__WebApplicantTestGroup": { "type": "object", "properties": { "groupName": { "maxLength": 200, "type": "string", "description": "The name of the web applicant test group.", "example": "Onboarding questions" } }, "additionalProperties": false }, "front_office__WebApplicantTestTalentAnswers": { "type": "object", "properties": { "answerText": { "type": "string", "description": "The web applicant's answers to the test question.", "example": "5 years" } }, "additionalProperties": false }, "front_office__WebApplicantTest": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 13489 }, "group": { "description": "Information about the web applicant test group.", "oneOf": [ { "$ref": "#/components/schemas/front_office__WebApplicantTestGroup" } ] }, "questions": { "type": "array", "description": "A list of test questions.", "items": { "type": "object", "description": "front_office__WebApplicantTestQuestion (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } }, "additionalProperties": false }, "front_office__TalentStage": { "required": [ "jobId", "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent nomination stage.", "format": "int32", "example": 42280 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 189482 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 175529 }, "jobActivityId": { "type": "integer", "description": "The identifier for the job activity.", "format": "int32", "example": 7382 }, "jobActivityName": { "maxLength": 255, "type": "string", "description": "The name of the job activity/talent nomination stage.", "example": "Offer Accepted" }, "stagedDate": { "type": "string", "description": "The UTC date-time the talent moved to the most current stage. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "jobActivityStartDate": { "type": "string", "description": "The UTC start date-time of the job activity. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "jobActivityEndDate": { "type": "string", "description": "The UTC end date-time of the job activity. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "declinedStageDate": { "type": "string", "description": "The UTC date-time the talent declined the job. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "startedStageDate": { "type": "string", "description": "The UTC date-time the talent accepted the talent nomination stage. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "stageType": { "maxLength": 255, "type": "string", "description": "The type of the nomination stage.", "example": "General" }, "creditTo": { "type": "integer", "description": "The identifier for the talent's representative or recruiter user record.", "format": "int32", "example": 24398 } }, "additionalProperties": false }, "front_office__TalentCertification": { "required": [ "certificationName", "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent Certification Tag.", "format": "int32", "example": 28456 }, "talentId": { "minimum": 1, "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 138345 }, "certificationId": { "type": "integer", "description": "The identifier for the Certification option.", "format": "int32", "example": 589 }, "certificationName": { "maxLength": 255, "type": "string", "description": "The name of the Certification option.", "example": "Forklift Certified" }, "expirationDate": { "type": "string", "description": "The expiration date of the Certification Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2026-12-01 or 2026-12-01T00:00:00.", "format": "date-time" } }, "additionalProperties": false }, "front_office__TalentCitizenship": { "required": [ "citizenshipName", "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Citizenship Tag.", "format": "int32", "example": 1837 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 16745 }, "citizenshipId": { "type": "integer", "description": "The identifier for the Citizenship option.", "format": "int32", "example": 843 }, "citizenshipName": { "maxLength": 100, "type": "string", "description": "The name of the Citizenship option.", "example": "Citizen" }, "expirationDate": { "type": "string", "description": "The expiration date of the Citizenship Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" } }, "additionalProperties": false }, "front_office__TalentCompanyExperience": { "required": [ "companyName", "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Company Experience Tag.", "format": "int32", "example": 299825 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 183992 }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 25998 }, "companyName": { "maxLength": 255, "type": "string", "description": "The name of the company.", "example": "ABC Corp" }, "expirationDate": { "type": "string", "description": "The expiration date of the talent's Company Experience Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats. For example, 2024-12-01, 2024-12-01T14:30:00.", "format": "date-time" } }, "additionalProperties": false }, "front_office__CompanyRestriction": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the company restriction.", "format": "int32", "example": 123456 }, "companyId": { "type": "integer", "description": "The identifier for the company the restriction applies to.", "format": "int32", "example": 284997 }, "branchIds": { "type": "string", "description": "The string representation of the array of identifiers for the departments the restriction applies to.", "example": "[1835, 1383, 1922]" }, "talentName": { "type": "string", "description": "The name of the talent who has been restricted from placement.", "example": "John Doe" }, "notes": { "type": "string", "description": "Notes on the restriction.", "example": "This talent is not eligible for placement due to previous performance issues." }, "userId": { "type": "integer", "description": "The identifier for the user who has added the restriction.", "format": "int32", "example": 12345 }, "userName": { "type": "string", "description": "The name of the user who has added a restriction.", "example": "Jane Smith" }, "companyName": { "type": "string", "description": "The name of the company the restriction applies to.", "example": "Acme Corp" }, "talentId": { "type": "integer", "description": "The identifier for the talent who is blocked from placement at the selected company or office.", "format": "int32", "example": 123456 }, "departments": { "type": "array", "description": "The departments where the talent is blocked from placement and their details.", "items": { "$ref": "#/components/schemas/front_office__Department" } }, "restrictionDate": { "type": "string", "description": "The date when the restriction has been added. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" } }, "additionalProperties": false }, "front_office__CompanyDnaDto": { "type": "object", "properties": { "dnaID": { "type": "integer", "description": "The identifier for the restriction.", "format": "int32", "example": 123 }, "companyID": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 456 }, "branchIDs": { "type": "array", "description": "The identifiers for the departments the restriction applies to.", "example": [ 789, 101112 ], "items": { "type": "integer", "format": "int32" } }, "talentID": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 18394 }, "restrictedByUserID": { "type": "integer", "description": "The identifier for the user who added the restriction.", "format": "int32", "example": 12345 }, "dnaDate": { "type": "string", "description": "The date when restriction was added. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "dnaNotes": { "type": "string", "description": "The notes for the restriction.", "example": "This is a sample note." } }, "additionalProperties": false }, "front_office__DepartmentAddress": { "allOf": [ { "$ref": "#/components/schemas/front_office__Address" }, { "type": "object", "properties": { "addressId": { "type": "integer", "description": "The identifier for the department address.", "format": "int32", "example": 12345 }, "branchId": { "type": "integer", "description": "The identifier for the company branch or department.", "format": "int32", "example": 12346 }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 12347 }, "addressType": { "description": "Address type for the department address.", "oneOf": [ { "$ref": "#/components/schemas/front_office__DepartmentAddressType" } ] }, "phone": { "maxLength": 255, "type": "string", "description": "The department's phone number.", "example": "+1-555-123-4567" }, "archive": { "type": "boolean", "description": "An indication of whether the department address is archived or not.", "example": false }, "isDefault": { "type": "boolean", "description": "An indication of whether the department address is the default address for the department.", "example": true }, "origin": { "maxLength": 50, "type": "string", "description": "The origin of the address of the department.", "example": "Acme Partner" }, "salesTaxes": { "type": "array", "description": "Sales tax options associated with this address, populated with full tax details.", "items": { "$ref": "#/components/schemas/front_office__SalesTaxOption" } } }, "additionalProperties": false } ] }, "front_office__Address": { "type": "object", "properties": { "street1": { "maxLength": 255, "type": "string", "description": "Street address, line 1.", "example": "123 Main Street" }, "street2": { "maxLength": 255, "type": "string", "description": "Street address, line 2.", "example": "Suite 100" }, "city": { "maxLength": 255, "type": "string", "description": "City.", "example": "St. Paul" }, "state_Province": { "maxLength": 2, "minLength": 2, "type": "string", "description": "ISO 2-character code for the Province, State, or Region.", "example": "MN" }, "postalCode": { "maxLength": 50, "type": "string", "description": "ZIP/postal code.", "example": "55121" }, "country": { "maxLength": 2, "minLength": 2, "type": "string", "description": "A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., \"US\", not \"USA\"). For details, see the General Guidelines.", "example": "US" }, "county": { "maxLength": 255, "type": "string", "description": "County.", "example": "Dakota" }, "geoCode": { "maxLength": 50, "type": "string", "description": "Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.", "example": "241231070" }, "schoolDistrictCode": { "maxLength": 50, "type": "string", "description": "School district code based on the Geo Code.", "example": "00000" } }, "additionalProperties": false }, "front_office__DepartmentAddressType": { "type": "string", "description": "The address types available for selection for a department address.", "enum": [ "Main", "Worksite", "Billing", "Unknown" ] }, "front_office__SalesTaxOption": { "type": "object", "properties": { "configSalesTaxGUID": { "type": "string", "description": "The unique identifier for the sales tax configuration.", "format": "uuid", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "name": { "maxLength": 255, "type": "string", "description": "The name of the sales tax.", "example": "Minnesota State Tax" }, "description": { "maxLength": 255, "type": "string", "description": "A description of the sales tax.", "example": "MN state sales tax rate" }, "state": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The US state code this sales tax applies to.", "example": "MN" } }, "additionalProperties": false }, "front_office__Department": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the department.", "format": "int32", "example": 123456 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the department.", "example": "Warehouse" }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 12345 }, "officeId": { "type": "integer", "description": "The identifier for the office.", "format": "int32", "example": 67890 }, "statusId": { "type": "integer", "description": "The identifier for the status.", "format": "int32", "example": 143 }, "status": { "maxLength": 255, "type": "string", "description": "The status value.", "example": "Active" }, "statusType": { "maxLength": 50, "type": "string", "description": "The status type value.", "example": "General" }, "parentDepartmentId": { "type": "integer", "description": "The identifier for the parent department.", "format": "int32", "example": 98765 }, "address": { "description": "Main address for the department.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "addresses": { "type": "array", "description": "List of addresses for the department.", "items": { "type": "object", "description": "front_office__DepartmentAddress (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "departmentPhone": { "maxLength": 255, "type": "string", "description": "Phone number of the department.", "example": "234-567-8900" }, "defaultJobOwnerIDs": { "type": "array", "description": "User IDs of the default job owners of the department.", "example": [ 123456, 789012 ], "items": { "type": "integer", "format": "int32" } }, "origin": { "maxLength": 50, "type": "string", "description": "The origin of the department.", "example": "Acme Partner" }, "originId": { "type": "integer", "description": "The identifier for the origin of the department.", "format": "int32", "example": 54321 }, "weekendDay": { "type": "string", "description": "The week end day for the department. Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.", "example": "Friday" }, "payPeriod": { "type": "string", "description": "The pay period for the department. Allowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.", "example": "Weekly" }, "payCycle": { "type": "string", "description": "The pay cycle for the department. Allowed values: 1, 2, 3, 4, Last Week.", "example": "2" }, "billingPeriod": { "type": "string", "description": "The billing period for the department. Allowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.", "example": "BiWeekly" }, "billingCycle": { "type": "string", "description": "The billing cycle for the department. Allowed values: 1, 2, 3, 4, Last Week.", "example": "2" }, "originRecordId": { "maxLength": 255, "type": "string", "description": "The identifier for the origin of the department from partner database.", "example": "DEPT-12345" } }, "additionalProperties": false }, "front_office__CompanySourceTags": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Company Source Tag for the company.", "format": "int32", "example": 12345 }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 67890 }, "companySourceId": { "type": "integer", "description": "The identifier for the Company Source option.", "format": "int32", "example": 45678 }, "companySourceName": { "maxLength": 255, "type": "string", "description": "The name of the Company Source option.", "example": "LinkedIn" } }, "additionalProperties": false }, "front_office__ContactSourceTag": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Contact Source Tag.", "format": "int32" }, "contactId": { "type": "integer", "description": "The identifier for the contact.", "format": "int32" }, "sourceNameId": { "type": "integer", "description": "The identifier for the Contact Source option.", "format": "int32" }, "sourceName": { "type": "string", "description": "The name of the Contact Source option." } }, "additionalProperties": false }, "front_office__ContactTag": { "allOf": [ { "$ref": "#/components/schemas/front_office__Tag" }, { "type": "object", "properties": { "contactId": { "type": "integer", "description": "The identifier for the contact.", "format": "int32" } }, "additionalProperties": false } ] }, "front_office__DepartmentDTO": { "required": [ "compId", "country", "departmentName", "stateProvince" ], "type": "object", "properties": { "compId": { "type": "integer", "description": "The identifier for company.", "format": "int32", "example": 123456 }, "departmentName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The name of the department.", "example": "Warehouse" }, "officeId": { "type": "integer", "description": "The identifier for the office.", "format": "int32", "example": 789012 }, "statusId": { "type": "integer", "description": "The identifier for the status.", "format": "int32", "example": 263 }, "parentDepartmentId": { "type": "integer", "description": "The identifier for the parent department.", "format": "int32", "example": 345678 }, "street1": { "maxLength": 255, "type": "string", "description": "Street address line 1 for the department.", "example": "123 Main Street" }, "street2": { "maxLength": 255, "type": "string", "description": "Street address line 2 for the department.", "example": "Suite 100" }, "city": { "maxLength": 255, "type": "string", "description": "City for the department.", "example": "Eagan" }, "stateProvince": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Province, state, or region for the department.", "example": "MN" }, "postalCode": { "maxLength": 255, "type": "string", "description": "ZIP/postal code for the department.", "example": "55121" }, "country": { "maxLength": 255, "minLength": 1, "type": "string", "description": "A 2-letter ISO 3166-1 alpha-2 code representing the department country (e.g., \"US\", not \"USA\"). For details, see the General Guidelines.", "example": "US" }, "geoCode": { "maxLength": 50, "type": "string", "description": "Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.", "example": "241234892" }, "departmentPhone": { "maxLength": 255, "type": "string", "description": "Phone number of the branch.", "example": "651-555-1234" }, "defaultJobOwnerIDs": { "type": "array", "description": "User IDs of the default job owners of the department.", "example": [ 12345, 67890 ], "items": { "type": "integer", "format": "int32" } }, "origin": { "maxLength": 50, "type": "string", "description": "The origin of the department.", "example": "PartnerXYZ" }, "weekEndDate": { "type": "string", "description": "Week End Date for the department.\nAllowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.", "example": "Friday" }, "payPeriod": { "type": "string", "description": "Pay Period for the department.\nAllowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.", "example": "Weekly" }, "payCycle": { "type": "string", "description": "Pay Cycle for the department.\nAllowed values: 1, 2, 3, 4, Last Week.", "example": "1" }, "billingPeriod": { "type": "string", "description": "Billing Period for the department.\nAllowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.", "example": "BiWeekly" }, "billingCycle": { "type": "string", "description": "Billing Cycle for the department.\nAllowed values: 1, 2, 3, 4, Last Week.", "example": "2" }, "originRecordId": { "maxLength": 255, "type": "string", "description": "The identifier for the origin of the department from partner database.", "example": "12345-abcde" } }, "additionalProperties": false }, "front_office__TalentIndustryExperience": { "required": [ "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Industry Experience Tag.", "format": "int32" }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 18494 }, "industryId": { "type": "integer", "description": "The identifier for the Industry option.", "format": "int32", "example": 277 }, "industryName": { "maxLength": 255, "type": "string", "description": "The name of the Industry option.", "example": "Retail" }, "expirationDate": { "type": "string", "description": "The expiration date of the Industry Experience Tag. The expiration date of the Industry Experience Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats. For example, 2026-12-01, 2026-12-01T14:00:00.", "format": "date-time" } }, "additionalProperties": false }, "back_office__TalentBenefitEnrollment": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/back_office__TalentBenefit" }, { "type": "object", "properties": { "partnerTransactionLookup": { "type": "object", "deprecated": true, "oneOf": [ { "$ref": "#/components/schemas/back_office__TransactionTypeLookUp" } ] } }, "additionalProperties": false } ] }, "back_office__TalentBenefitGetResult": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/back_office__TalentBenefit" }, { "type": "object", "properties": { "employerGuid": { "type": "string", "description": "The identifier for the employer, formatted as GUID.", "format": "uuid" } }, "additionalProperties": false } ] }, "back_office__TransactionTypeLookUp": { "type": "object", "properties": { "deductionTypeName": { "type": "string", "description": "The name of the deduction type associated with the transaction." }, "coverageLevel": { "type": "string", "description": "The coverage level for the associated transaction." } }, "additionalProperties": false }, "back_office__TalentBenefit": { "required": [ "talentGuid" ], "type": "object", "properties": { "talentGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "guid" }, "supplierGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the staffing company (supplier), formatted as a GUID. This is used to identify the supplier associated with the talent's benefit.", "format": "guid" }, "transactionTypeId": { "type": "integer", "description": "The unique identifier for the talent benefit transaction type.", "format": "int32" }, "benefitPayrollDeduction": { "$ref": "#/components/schemas/back_office__TalentBenefitDeduction" }, "benefitPayrollContribution": { "$ref": "#/components/schemas/back_office__TalentBenefitContribution" } }, "additionalProperties": false }, "back_office__TalentBenefitDeduction": { "required": [ "deductionAmount", "deductionPayCycle", "deductionStartDate" ], "type": "object", "properties": { "talentBenefitDeductionGuid": { "type": "string", "description": "A unique identifier for the talent benefit deduction, formatted as a GUID.", "format": "guid" }, "deductionAmount": { "type": "number", "description": "The amount to be deducted.", "format": "double" }, "deductionAmountType": { "$ref": "#/components/schemas/back_office__DeductionContributionAmountType" }, "deductionStartDate": { "minLength": 1, "type": "string", "description": "The start date for the deduction. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-01T14:30:00Z or 2024-12-01T14:30:00.1234567+00:00.", "format": "date-time" }, "deductionEndDate": { "type": "string", "description": "The end date for the deduction. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-01T14:30:00Z or 2024-12-01T14:30:00.1234567+00:00.", "format": "date-time" }, "deductionPayCycle": { "$ref": "#/components/schemas/back_office__PayPeriod" }, "referenceNumber": { "type": "string", "description": "A reference number associated with the deduction." }, "payPeriodLimit": { "type": "number", "description": "The maximum deduction amount allowed per pay period. If no limit, then set to 0.", "format": "decimal" }, "monthlyLimit": { "type": "number", "description": "The maximum deduction amount allowed per month. If no limit, then set to 0.", "format": "decimal" }, "yearlyLimit": { "type": "number", "description": "The maximum deduction amount allowed per year. If no limit, then set to 0.", "format": "decimal" }, "lifeTimeLimit": { "type": "number", "description": "The maximum deduction amount allowed over the lifetime of the deduction. If no limit, then set to 0.", "format": "decimal" }, "note": { "type": "string", "description": "An optional note or comment related to the deduction." }, "isActive": { "type": "boolean", "description": "An indication of whether the deduction is active or not." }, "isCourtOrdered": { "type": "boolean", "description": "An indication of whether the deduction is the result of a court order." } }, "additionalProperties": false }, "back_office__TalentBenefitContribution": { "required": [ "contributionAmount", "contributionPayCycle", "contributionStartDate" ], "type": "object", "properties": { "talentBenefitContributionGuid": { "type": "string", "description": "A unique identifier for the talent benefit contribution, formatted as a GUID.", "format": "guid" }, "contributionAmount": { "type": "number", "description": "The amount the employer will contribute to the talent.", "format": "double" }, "contributionAmountType": { "$ref": "#/components/schemas/back_office__DeductionContributionAmountType" }, "contributionStartDate": { "minLength": 1, "type": "string", "description": "The start date for the contribution. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-01T14:30:00Z or 2024-12-01T14:30:00.1234567+00:00.", "format": "date-time" }, "contributionEndDate": { "type": "string", "description": "The end date for the contribution. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-01T14:30:00Z or 2024-12-01T14:30:00.1234567+00:00.", "format": "date-time" }, "contributionPayCycle": { "$ref": "#/components/schemas/back_office__PayPeriod" }, "referenceNumber": { "type": "string", "description": "A reference number associated with the benefit contribution." }, "payPeriodLimit": { "type": "number", "description": "The maximum contribution amount allowed per pay period. If no limit, then set to 0.", "format": "decimal" }, "monthlyLimit": { "type": "number", "description": "The maximum contribution amount allowed per month. If no limit, then set to 0.", "format": "decimal" }, "yearlyLimit": { "type": "number", "description": "The maximum contribution amount allowed per year. If no limit, then set to 0.", "format": "decimal" }, "lifeTimeLimit": { "type": "number", "description": "The maximum contribution amount allowed over the lifetime of the contribution. If no limit, then set to 0.", "format": "decimal" }, "note": { "type": "string", "description": "An optional note or comment related to the contribution." }, "isActive": { "type": "boolean", "description": "An indication of whether the contribution is active or not." } }, "additionalProperties": false }, "back_office__ServiceResultResourceNotFoundError": { "type": "object", "properties": { "id": { "type": "string" } } }, "back_office__PayPeriod": { "type": "string", "enum": [ "Unknown", "Weekly", "BiWeekly", "Monthly", "SemiMonthly", "Daily", "Yearly", "Hourly" ] }, "back_office__DeductionContributionAmountType": { "type": "string", "enum": [ "Fixed", "PercentOfGross", "PercentOfNet" ] }, "front_office__PipelineTalentStage": { "required": [ "jobActivityDate", "jobId", "stageType", "stagedDate", "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent pipeline stage.", "format": "int32", "example": 189482 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 189482 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 175529 }, "jobActivityId": { "type": "integer", "description": "The identifier for the job activity.", "format": "int32", "example": 7382 }, "jobActivityName": { "maxLength": 255, "type": "string", "description": "The name of the job activity/talent pipeline stage.", "example": "Pipelined" }, "stagedDate": { "type": "string", "description": "The date the talent was added to a pipeline stage. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "jobActivityDate": { "type": "string", "description": "The date of the job activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "declinedStageDate": { "type": "string", "description": "The date the talent declined the job. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "stageType": { "maxLength": 255, "type": "string", "description": "The type of the pipeline stage.", "example": "General" }, "creditTo": { "type": "integer", "description": "The identifier for the talent's representative or recruiter user record.", "format": "int32", "example": 24398 }, "message": { "type": "string", "description": "The response message returned to the API caller.", "example": "Please note that this applicant was previously pipelined, but then declined." } }, "additionalProperties": false }, "front_office__TalentQuickSearchTitle": { "required": [ "talentId", "titleName" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent Quick Search Title Tag.", "format": "int32", "example": 29184 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 189482 }, "titleId": { "type": "integer", "description": "The identifier for the quick title option.", "format": "int32", "example": 5839 }, "titleName": { "maxLength": 255, "type": "string", "description": "The name of the quick title option.", "example": "Accounting" }, "expirationDate": { "type": "string", "description": "The expiration date of the Quick Search Title Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" } }, "additionalProperties": false }, "front_office__ReferrerOf": { "type": "object", "properties": { "referralId": { "type": "integer", "description": "The identifier for the referral record.", "format": "int32", "example": 1894 }, "referrerOfId": { "type": "integer", "description": "The identifier for the talent or contact who was referred. It is required when adding a ReferrerOf referral.", "format": "int32", "example": 138952 }, "referrerOfName": { "maxLength": 255, "type": "string", "description": "The name of the person who was referred.", "example": "Jane Doe" }, "referrerOfEntityType": { "type": "string", "description": "The entity type for the person who was referred.\nWhen adding a ReferrerOf referral the value must be 'Talent' or 'Contact'.", "example": "Talent" }, "referralDate": { "type": "string", "description": "The date of the referral.\nWhen adding a referral, the date will default to the current date-time if not passed in. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" } }, "additionalProperties": false }, "front_office__ReferredBy": { "type": "object", "properties": { "referralId": { "type": "integer", "description": "The identifier for the referral record.", "format": "int32", "example": 2842 }, "referredById": { "type": "integer", "description": "The identifier for the person who made the referral, if they are a talent or contact in Bold.\nIt is possible to add a ReferredBy referral by name only if ReferredById is 0 or is not passed in.", "format": "int32", "example": 167395 }, "referredByName": { "maxLength": 255, "type": "string", "description": "The name of the person who made the referral.\nIt is possible to add a ReferredBy referral by name only if ReferredById is 0 or is not passed in.", "example": "Jane Doe" }, "referredByEntityType": { "type": "string", "description": "The entity type for the person who made the referral.\nWhen adding a ReferredBy referral, if the person is a talent or contact in Bold and a ReferredById is passed in, then the value must be 'Talent' or 'Contact'.", "example": "Talent" }, "referralDate": { "type": "string", "description": "The date of the referral.\nWhen adding a referral, the date will default to the current date-time if not passed in. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" } }, "additionalProperties": false }, "front_office__TalentReferralsResponse": { "type": "object", "properties": { "referrals": { "description": "The collection of referrals associated with the talent after an attempt to add one or more talent referrals.", "oneOf": [ { "$ref": "#/components/schemas/front_office__TalentReferrals" } ] }, "errors": { "type": "array", "description": "A list of error messages after an attempt to add one or more talent referrals.", "items": { "type": "string" } } }, "additionalProperties": false }, "front_office__TalentReferrals": { "required": [ "talentId" ], "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 18394 }, "referredBy": { "type": "array", "description": "The list of referrals that referred the talent.", "items": { "$ref": "#/components/schemas/front_office__ReferredBy" } }, "referrerOf": { "type": "array", "description": "The list of referrals initiated by the talent.", "items": { "$ref": "#/components/schemas/front_office__ReferrerOf" } } }, "additionalProperties": false }, "front_office__ArrayOfTalentSkill": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentSkill" } }, "front_office__TalentSkillResponse": { "type": "object", "properties": { "talentSkills": { "type": "array", "description": "A list of talent skills and their details.", "items": { "type": "object", "description": "front_office__TalentSkill (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "errors": { "type": "array", "description": "A list of errors and their details.", "items": { "type": "string" } } }, "additionalProperties": false }, "front_office__TalentSkill": { "type": "object", "properties": { "skillId": { "type": "integer", "description": "The identifier for the talent skill.", "format": "int32", "example": 2847 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 29384 }, "positionId": { "type": "integer", "description": "The identifier for the position option.", "format": "int32", "example": 643 }, "descriptionId": { "type": "integer", "description": "The identifier for the description option.", "format": "int32", "example": 7221 }, "skillPosition": { "maxLength": 100, "type": "string", "description": "The talent skill position option.", "example": "Clerical" }, "skillDescription": { "maxLength": 255, "type": "string", "description": "The talent skill description option.", "example": "Data Entry" }, "skillTalentFacing": { "type": "boolean", "description": "An indication of whether a skill is visible and applicable to talent users.", "readOnly": true, "example": true } }, "additionalProperties": false }, "front_office__TalentSource": { "required": [ "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Talent Source Tag.", "format": "int32", "example": 28942 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 19390 }, "sourceId": { "type": "integer", "description": "The identifier for the Talent Source option.", "format": "int32", "example": 284 }, "sourceName": { "maxLength": 255, "type": "string", "description": "The name of the Talent Source option.", "example": "LinkedIn" }, "expirationDate": { "type": "string", "description": "The expiration date of the Talent Source Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" } }, "additionalProperties": false }, "front_office__TalentTag": { "required": [ "detail", "tag", "talentId" ], "type": "object", "properties": { "talentTagId": { "type": "integer", "description": "The identifier for the Talent Tag.", "format": "int32", "example": 4283 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 124785 }, "tagId": { "type": "integer", "description": "The identifier for the Talent Tag option.", "format": "int32", "example": 552 }, "tag": { "maxLength": 255, "type": "string", "description": "The text of the Talent Tag option.", "example": "Language" }, "detailId": { "type": "integer", "description": "The identifier for the details option.", "format": "int32", "example": 782 }, "detail": { "maxLength": 255, "type": "string", "description": "The text of the details option.", "example": "Spanish" }, "expirationDate": { "type": "string", "description": "The expiration date of the Talent Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" } }, "additionalProperties": false }, "front_office__TenantCompanyMapping": { "required": [ "companyIds", "tenantId" ], "type": "object", "properties": { "tenantId": { "type": "integer", "description": "The identifier for the tenant.", "format": "int32", "example": 796 }, "companyIds": { "type": "array", "description": "The list of company identifiers under the specified tenant.", "example": [ 12345, 67890 ], "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "front_office__UniversalCompanyRestrictionRequest": { "required": [ "restrictedByUserId", "talentId", "tenantCompanies" ], "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 138344 }, "tenantCompanies": { "minItems": 1, "type": "array", "description": "List of tenant and associated company identifiers where the talent should be restricted.", "items": { "$ref": "#/components/schemas/front_office__TenantCompanyMapping" } }, "restrictedByUserId": { "type": "integer", "description": "The user identifier who is adding the restriction.", "format": "int32", "example": 18994 }, "dnaDate": { "type": "string", "description": "The date when the restriction was added. Defaults to current date if null. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "dnaNotes": { "type": "string", "description": "Any additional notes regarding the restriction.", "example": "This is a sample note." } }, "additionalProperties": false }, "front_office__UniversalCompanyRestrictionResponse": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 18394 }, "tenantCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TenantCompanyMapping" } }, "restrictedByUserId": { "type": "integer", "description": "The identifier for the user who added the restriction.", "format": "int32", "example": 12345 }, "dnaDate": { "type": "string", "description": "The date when restriction was added. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "dnaNotes": { "type": "string", "description": "The notes for the restriction.", "example": "This is a sample note." }, "errors": { "type": "array", "description": "A list of error messages, if any.", "example": [ "Error 1", "Error 2" ], "items": { "type": "string" } } }, "additionalProperties": false }, "front_office__ArrayOfCancelScheduleShiftResponse": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__CancelScheduleShiftResponse" } }, "front_office__IntegerSchema": { "type": "integer", "format": "int32" }, "front_office__CancelScheduleShiftResponse": { "type": "object", "properties": { "scheduleShiftId": { "type": "integer", "format": "int64" }, "isSuccess": { "type": "boolean" }, "errorMessage": { "type": "string" }, "errorCode": { "type": "string" } }, "additionalProperties": false }, "front_office__ArrayOfIntegerSchema": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__IntegerSchema" } }, "front_office__TalentCertificate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier for the talent certificate instance. Matches the *certificateId* provided in the request path.", "format": "int32", "example": 52910 }, "certificateId": { "type": "integer", "description": "The identifier for the certificate definition associated with the talent certificate.", "format": "int32", "example": 392 }, "categoryId": { "type": "integer", "description": "The identifier for the certificate category.", "format": "int32", "example": 58 }, "applicantId": { "type": "integer", "description": "The identifier for the talent who holds the certificate.", "format": "int32", "example": 18499 }, "issueDate": { "type": "string", "description": "The date the certficate was issued. The field follows the YYYY-MM-DDTHH:mm:ss format, for example, 2024-12-01T14:30:00 or 2024-12-01T00:00:00.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "The date the certificate is set to expire. The field follows the YYYY-MM-DDTHH:mm:ss format, for example, 2024-12-01T14:30:00 or 2024-12-01T00:00:00.", "format": "date-time" }, "notes": { "type": "string", "description": "Additional notes related to the talent certificate.", "example": "Waiting for validation." }, "validated": { "type": "boolean", "description": "An indication of whether the certificate has been validated or not.", "example": true }, "validatedDate": { "type": "string", "description": "The date and time the certificate was validated. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "validatedBy": { "type": "integer", "description": "The identifier for the user that has validated the certificate of the talent.", "format": "int32", "example": 13483 }, "archived": { "type": "boolean", "description": " An indication of whether the certificate is archived or not.", "example": false }, "archiveDate": { "type": "string", "description": "The date the certificate was set to archived. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546. ", "format": "date-time" }, "certificateNumber": { "maxLength": 255, "type": "string", "description": "The official number or reference assigned to the certificate.", "example": "A25623" }, "certificateName": { "maxLength": 255, "type": "string", "description": "The name of the certificate.", "example": "Tetanus vaccination" }, "categoryName": { "maxLength": 255, "type": "string", "description": "The name of the category the certificate belongs to.", "example": "Vaccinations" }, "talentFirstName": { "maxLength": 255, "type": "string", "description": "The first name of the talent the certificate was issued to.", "example": "John" }, "talentLastName": { "maxLength": 255, "type": "string", "description": "The last name of the talent the certificate was issued to.", "example": "Doe" }, "certificateAuthorityId": { "type": "integer", "description": "The identifier for the authority that issued the certificate.", "format": "int32", "example": 350 }, "certificateAuthorityName": { "maxLength": 255, "type": "string", "description": "The name of the authority that issued the certificate.", "example": "America - MN" } }, "additionalProperties": false }, "front_office__ArrayOfOperation": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__Operation" } }, "front_office__OperationBase": { "type": "object", "properties": { "path": { "type": "string", "description": "A JSON Pointer indicating the location in the document to apply the operation." }, "op": { "type": "string", "description": "Specifies the type of operation (e.g., add, remove, replace, move, copy, and test)." }, "from": { "type": "string", "description": "The source path for move and copy operations." } }, "additionalProperties": false }, "front_office__Operation": { "allOf": [ { "$ref": "#/components/schemas/front_office__OperationBase" }, { "type": "object", "properties": { "value": { "type": "object", "description": "The value to be added, replaced, or tested (required for add, replace, and test operations)." } }, "additionalProperties": false, "description": "A JSON Patch Document operation." } ] }, "front_office__SystemCertificateAuthority": { "type": "object", "properties": { "certificateAuthorityId": { "type": "integer", "description": "The identifier for the certificate authority.", "format": "int32", "example": 248 }, "certificateAuthorityName": { "maxLength": 255, "type": "string", "description": "The name for the certificate authority.", "example": "America - MN" }, "isArchive": { "type": "boolean", "description": "True or false value if the certificate authority is archived or not.", "example": false }, "archivedByUserId": { "type": "integer", "description": "The identifier for the user that archived the certificate authority.", "format": "int32", "example": 13991 }, "archivedDate": { "type": "string", "description": "The archived date for the certificate authority. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" } }, "additionalProperties": false }, "front_office__SystemCertificate": { "type": "object", "properties": { "certificateId": { "type": "integer", "description": "The identifier for the certificate definition.", "format": "int32", "example": 284 }, "certificateName": { "maxLength": 255, "type": "string", "description": "The name of the certificate.", "example": "Tetanus vaccination" }, "certificateCategoryId": { "type": "integer", "description": "The identifier for the certificate category.", "format": "int32", "example": 635 }, "certificateCategoryname": { "maxLength": 255, "type": "string", "description": "The certificate category name.", "example": "Vaccinations" }, "certificateAuthorities": { "type": "array", "description": "Collection of certificate authorities.", "items": { "type": "object", "description": "front_office__SystemCertificateAuthority (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "isArchive": { "type": "boolean", "description": "True or false value if the certificate is archived or not.", "example": false }, "archivedByUserId": { "type": "integer", "description": "The identifier for the user that archived the certificate.", "format": "int32", "example": 118476 }, "archivedDate": { "type": "string", "description": "The date the certificate was archived. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "front_office__ArrayOfSystemCertificate": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__SystemCertificate" } }, "front_office__Version": { "type": "object", "properties": { "major": { "type": "integer", "format": "int32" }, "minor": { "type": "integer", "format": "int32" }, "build": { "type": "integer", "format": "int32" }, "revision": { "type": "integer", "format": "int32" }, "majorRevision": { "type": "integer", "format": "int32" }, "minorRevision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "front_office__Health": { "type": "object", "properties": { "serviceVersion": { "description": "The version number of the primary assembly for the service.\nMajor: The major version of the API.\nMinor: The minor version of the API.\nBuild: The build number of the API.\nRevision: The revision number of the API.\nMajorRevision: The major revision version of the API.\nMinorRevision: The minor revision version of the API.\n ", "oneOf": [ { "$ref": "#/components/schemas/front_office__Version" } ] }, "machineName": { "type": "string", "description": "The name of the server this instance of the service is running upon.\n " }, "timestamp": { "type": "string", "description": "The date and time of this request.\n ", "format": "date-time" }, "connectionStatus": { "type": "string", "description": "The status of DB connection instance\n " } }, "additionalProperties": false, "description": "Holds basic information about the service's health.\n " }, "back_office__Version": { "type": "object", "properties": { "major": { "type": "integer", "description": "The major version of the API.", "format": "int32" }, "minor": { "type": "integer", "description": "The minor version of the API.", "format": "int32" }, "build": { "type": "integer", "description": "The build number of the API.", "format": "int32" }, "revision": { "type": "integer", "description": "The revision number of the API.", "format": "int32" }, "majorRevision": { "type": "integer", "description": "The major revision version of the API.", "format": "int32" }, "minorRevision": { "type": "integer", "description": "The minor revision version of the API.", "format": "int32" } }, "additionalProperties": false }, "back_office__Health": { "type": "object", "properties": { "compasIntegrationServiceVersion": { "type": "object", "description": "The version number of the primary assembly for the service.", "oneOf": [ { "$ref": "#/components/schemas/back_office__Version" } ] }, "machineName": { "type": "string", "description": "The name of the server this instance of the service is running upon.\n " }, "timestamp": { "type": "string", "description": "The date and time of this request.\n ", "format": "date-time" } }, "additionalProperties": false }, "front_office__ContactDTO": { "required": [ "emailAddress", "firstName", "lastName" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the contact.", "format": "int32" }, "firstName": { "minLength": 1, "type": "string", "description": "The contact's first name." }, "middleName": { "type": "string", "description": "The contact's middle name." }, "lastName": { "minLength": 1, "type": "string", "description": "The contact's last name." }, "workPhone": { "type": "string", "description": "The contact's work phone." }, "cellPhone": { "type": "string", "description": "The contact's cell phone." }, "emailAddress": { "minLength": 1, "type": "string", "description": "The contact's email address." }, "address1": { "type": "string", "description": "The contact's address, line 1." }, "address2": { "type": "string", "description": "The contact's address, line 2." }, "city": { "type": "string", "description": "The contact's city." }, "state": { "type": "string", "description": "The contact's state/province." }, "postalCode": { "type": "string", "description": "The contact's ZIP/postal code." }, "country": { "type": "string", "description": "The contact's country." }, "link": { "type": "string", "description": "URL to the contact profile." }, "companyName": { "type": "string", "description": "The name of the company." }, "companyId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The identifier for the company.", "format": "int32" }, "companyDepartmentId": { "type": "integer", "description": "The identifier for the company department.", "format": "int32" }, "title": { "type": "string", "description": "The contact's title within the organization." }, "emailOptOut": { "type": "boolean", "description": "An indication of whether the contact has opted out of receiving emails from Avionté BOLD or not." }, "isArchived": { "type": "boolean", "description": "An indication of whether the contact record is archived or not." }, "createdDate": { "type": "string", "description": "The date the contact profile was created.", "format": "date-time" }, "status": { "type": "string", "description": "The contact's status." }, "origin": { "type": "string", "description": "The partner or vendor that originated the request." }, "representativeUsers": { "type": "array", "description": "The ID of the representative who is working with the contact.", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "front_office__Contact": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the contact.", "format": "int32" }, "firstName": { "type": "string", "description": "The contact's first name." }, "middleName": { "type": "string", "description": "The contact's middle name." }, "lastName": { "type": "string", "description": "The contact's last name." }, "workPhone": { "type": "string", "description": "The contact's work phone." }, "cellPhone": { "type": "string", "description": "The contact's cell phone." }, "emailAddress": { "type": "string", "description": "The contact's email address." }, "emailAddress2": { "type": "string", "description": "The contact's secondary email address." }, "address1": { "type": "string", "description": "The contact's address, line 1." }, "address2": { "type": "string", "description": "The contact's address, line 2." }, "city": { "type": "string", "description": "The contact's city." }, "state": { "type": "string", "description": "The contact's state/province." }, "postalCode": { "type": "string", "description": "The contact's ZIP/postal code." }, "country": { "type": "string", "description": "The contact's country." }, "link": { "type": "string", "description": "URL to the contact profile." }, "companyName": { "type": "string", "description": "The name of the company." }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32" }, "companyDepartmentId": { "type": "integer", "description": "The identifier for the company department.", "format": "int32" }, "title": { "type": "string", "description": "The contact's title within the organization." }, "emailOptOut": { "type": "boolean", "description": "An indication of whether the contact has opted out of receiving emails from Avionté BOLD or not." }, "isArchived": { "type": "boolean", "description": "An indication of whether the contact record is archived or not." }, "representativeUsers": { "type": "array", "description": "The IDs of the Hiring Manager's representatives.", "items": { "type": "integer", "format": "int32" } }, "createdDate": { "type": "string", "description": "The date the contact profile was created.", "format": "date-time" }, "lastUpdatedDate": { "type": "string", "description": "The date of the most recent update to the contact profile.", "format": "date-time" }, "latestActivityDate": { "type": "string", "description": "The date of the contact's latest activity.", "format": "date-time" }, "latestActivityName": { "type": "string", "description": "The contact's latest activity type." }, "status": { "type": "string", "description": "The contact's status." }, "statusType": { "type": "string", "description": "The contact's status type (Active/Inactive)." }, "origin": { "type": "string", "description": "The partner or vendor that originated the request." } }, "additionalProperties": false }, "front_office__ContactSearchDTO": { "type": "object", "properties": { "companyID": { "type": "integer", "description": "The identifier for the contact's company ID.", "format": "int32" }, "contactEmail": { "type": "string", "description": "The email address of the contact." } }, "additionalProperties": false }, "front_office__WorkerCompCode": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the worker's comp code.", "format": "int32", "example": 12345 }, "wcCode": { "maxLength": 50, "type": "string", "description": "The worker's comp code.", "example": "4136" }, "wcDescription": { "maxLength": 255, "type": "string", "description": "Description for the worker's comp code.", "example": "Clerical Office Employees" }, "wcState": { "maxLength": 50, "type": "string", "description": "The state/province the worker's comp code is for.", "example": "CA" }, "wcCountry": { "maxLength": 255, "type": "string", "description": "The country the worker's comp code is for.", "example": "US" }, "employerId": { "type": "integer", "description": "The identifier for the employer the worker's comp code is for.", "format": "int32", "example": 12345 }, "officeIds": { "type": "array", "description": "The identifiers for the offices the worker's comp code is for.", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "front_office__OvertimeType": { "type": "string", "description": "The overtime types available for selection for a job.", "enum": [ "StraightTime", "PaidAndBilledOT", "PaidNotBilledOT" ] }, "front_office__JobScheduleShiftBasicBase": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Job Schedule Shift.", "format": "int32", "example": 12345 }, "shiftDay": { "type": "integer", "description": "The identifier for the shift weekday, starting with 0 for Sunday.", "format": "int32", "example": 1 }, "duration": { "type": "integer", "description": "The shift duration in minutes.", "format": "int32", "example": 480 }, "startTime": { "type": "string", "description": "Hours and minutes for start time in 24-hour local time.", "format": "duration", "example": "08:00:00" }, "positions": { "type": "integer", "description": "Number of positions for the shift.", "format": "int32", "example": 2 }, "createdDate": { "type": "string", "description": "The date the shift was created. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "updatedDate": { "type": "string", "description": "The date the shift was last updated. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" } }, "additionalProperties": false }, "front_office__JobScheduleShiftDto": { "allOf": [ { "$ref": "#/components/schemas/front_office__JobScheduleShiftBasicBase" }, { "type": "object", "additionalProperties": false } ] }, "front_office__PayPeriod": { "type": "string", "description": "The pay period available for a job.", "enum": [ "None", "Weekly", "BiWeekly", "Daily", "Monthly", "SemiMonthly", "Yearly", "Hourly" ] }, "front_office__ExpenseType": { "type": "string", "description": "The expense types available for selection for a job.", "enum": [ "None", "PaidAndBilled", "PaidNotBilled" ] }, "front_office__CustomJobDetail": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the custom job details.", "format": "int32", "example": 12345 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 67890 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the detail.", "example": "Dress Code" }, "value": { "type": "string", "description": "The value of the detail. The format of the value depends on the type of detail. If the type is 'checkbox', the value can be 'Yes' or 'No'. If the type is 'minmax', the value can be a string representing the minimum value, like '10'. If the type is 'numeric', the value can be a number like '15'. If the type is 'time', the value can be a time string like '08:00'. If the type is 'text', the value can be a string like 'Business Casual'.", "example": "Business Casual" }, "additionalValue": { "maxLength": 255, "type": "string", "description": "An additional value needed for the detail. If the type is 'minmax', the value can be a string representing the maximum value, like '100'.", "example": "No jeans" }, "type": { "type": "string", "description": "The type of detail. The possible values are 'checkbox', 'minmax', 'numeric', 'text', 'time'.", "example": "text" }, "isActive": { "type": "boolean", "description": "An indication of whether the detail is active or not.", "example": true }, "customJobDetailId": { "type": "integer", "description": "An identifier for the custom job detail definition.", "format": "int32", "example": 54321 } }, "additionalProperties": false }, "front_office__WeekDuration": { "type": "string", "description": "The week duration options available for a job.", "enum": [ "MondayToSunday", "SundayToSaturday", "SaturdayToFriday" ] }, "front_office__BillingTerm": { "type": "string", "description": "The billing term options available for a job used for invoicing a customer. Options include \"DueUponReceipt\" and NetN terms, where N is the number of days in which the payment is due. For example, Net7 creates an invoice due 7 days after the date of the invoice.", "enum": [ "DueUponReceipt", "Net7", "Net10", "Net15", "Net20", "Net30", "Net35", "Net45", "Net60", "Net65", "Net90", "Net120", "Net135" ] }, "front_office__JobDto": { "required": [ "branchId", "companyId", "contactId", "frontOfficeId", "orderTypeId", "origin", "ownerUserId", "positions", "startDate", "statusId", "title", "worksiteAddressId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 188499 }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 17845 }, "branchId": { "type": "integer", "description": "The identifier for the company branch or department.", "format": "int32", "example": 17582 }, "frontOfficeId": { "type": "integer", "description": "The identifier for the job's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.", "format": "int32", "example": 2774 }, "contactId": { "type": "integer", "description": "The identifier for the company contact.", "format": "int32", "example": 178843 }, "worksiteAddressId": { "type": "integer", "description": "The identifier for the worksite address.", "format": "int32", "example": 17748 }, "positions": { "type": "integer", "description": "The number of positions.", "format": "int32", "example": 5 }, "startDate": { "minLength": 1, "type": "string", "description": "The estimated start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "endDate": { "type": "string", "description": "The estimated end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "estimatedHours": { "type": "integer", "description": "The estimated amount of time the job requires.", "format": "int32", "example": 40 }, "targetBillRate": { "type": "number", "description": "The target bill rate for the job.", "format": "decimal", "example": 30 }, "targetPayRate": { "type": "number", "description": "The target pay rate for the job.", "format": "decimal", "example": 25 }, "overtimeType": { "description": "Information about the overtime type.", "example": "PaidAndBilledOT", "oneOf": [ { "$ref": "#/components/schemas/front_office__OvertimeType" } ] }, "expenseType": { "description": "Information about the expense type.", "example": "PaidAndBilled", "oneOf": [ { "$ref": "#/components/schemas/front_office__ExpenseType" } ] }, "overtimeRuleId": { "type": "integer", "description": "The identifier for the overtime rule.", "format": "int32", "example": 434 }, "useCustomOTRates": { "type": "boolean", "description": "A flag indicating custom overtime rates can be used.", "example": true }, "overtimeBillRate": { "type": "number", "description": "The overtime bill rate value.", "format": "decimal", "example": 45 }, "overtimePayRate": { "type": "number", "description": "The overtime pay rate value.", "format": "decimal", "example": 37.5 }, "doubletimeBillRate": { "type": "number", "description": "The double time bill rate value.", "format": "decimal", "example": 60 }, "doubletimePayRate": { "type": "number", "description": "The double time pay rate value.", "format": "decimal", "example": 50 }, "maxBillRate": { "type": "number", "description": "The maximum bill rate value.", "format": "decimal", "example": 60 }, "minBillRate": { "type": "number", "description": "The minimum bill rate value.", "format": "decimal", "example": 30 }, "maxPayRate": { "type": "number", "description": "The maximum pay rate value.", "format": "decimal", "example": 50 }, "minPayRate": { "type": "number", "description": "The minimum pay rate value.", "format": "decimal", "example": 25 }, "rateType": { "description": "The rate type for the job.", "example": "HourlyRate", "oneOf": [ { "$ref": "#/components/schemas/front_office__JobRateType" } ] }, "weekDuration": { "description": "The week duration option for the job.", "example": "MondayToSunday", "oneOf": [ { "$ref": "#/components/schemas/front_office__WeekDuration" } ] }, "markupPercentage": { "type": "number", "description": "The mark-up percentage value.", "format": "decimal", "example": 8 }, "billingManagerId": { "type": "integer", "description": "The identifier for the billing manager for the job.", "format": "int32", "example": 148724 }, "billingName": { "maxLength": 255, "type": "string", "description": "The name of the billing contact.", "example": "John Doe" }, "billingAddress1": { "maxLength": 255, "type": "string", "description": "Billing address, line 1.", "example": "123 Main Street" }, "billingAddress2": { "maxLength": 100, "type": "string", "description": "Billing address, line 2.", "example": "Suite 100" }, "billingCity": { "maxLength": 50, "type": "string", "description": "Billing city.", "example": "Eagan" }, "billingState": { "maxLength": 50, "type": "string", "description": "Billing state.", "example": "MN" }, "billingZip": { "maxLength": 50, "type": "string", "description": "Billing ZIP/postal code.", "example": "55121" }, "billingPhone": { "maxLength": 50, "type": "string", "description": "Billing contact phone.", "example": "651-555-1234" }, "billingEmail": { "maxLength": 100, "type": "string", "description": "Billing contact email.", "example": "john.doe@example.com" }, "billingTerm": { "description": "The billing term.", "example": "DueUponReceipt", "oneOf": [ { "$ref": "#/components/schemas/front_office__BillingTerm" } ] }, "placementFee": { "type": "number", "description": "The placement fee for the job.", "format": "decimal", "example": 25 }, "placementPercentage": { "type": "number", "description": "The placement percentage for the job.", "format": "float", "example": 5 }, "title": { "maxLength": 500, "minLength": 1, "type": "string", "description": "The title for the job.", "example": "Warehouse Worker" }, "positionCategoryId": { "type": "integer", "description": "The identifier for the position category.", "format": "int32", "example": 247 }, "costCenter": { "maxLength": 50, "type": "string", "description": "The company's cost center.", "example": "Center A" }, "division": { "maxLength": 50, "type": "string", "description": "The company's division.", "example": "Employer ABC" }, "department": { "maxLength": 50, "type": "string", "description": "The company department name.", "example": "Warehouse" }, "workerCompCodeId": { "type": "integer", "description": "The identifier for the worker's comp code.", "format": "int32", "example": 4136 }, "statusId": { "type": "integer", "description": "The identifier for the job order status.", "format": "int32", "example": 273 }, "orderTypeId": { "type": "integer", "description": "The identifier for the job type.", "format": "int32", "example": 248 }, "salesRepUserId": { "type": "integer", "description": "The identifier for the sales representative user for the job.", "format": "int32", "example": 17845 }, "ownerUserId": { "type": "integer", "description": "The identifier for the user who created a job.", "format": "int32", "example": 17845 }, "description": { "type": "string", "description": "The job description.", "example": "General warehouse duties including picking, packing, and shipping." }, "notes": { "type": "string", "description": "The job notes.", "example": "Handle all incoming shipments and ensure proper documentation." }, "customJobDetails": { "type": "array", "description": "A list of custom job details.", "items": { "$ref": "#/components/schemas/front_office__CustomJobDetail" } }, "origin": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The partner or vendor that originated the request.", "example": "Partner XYZ" }, "isArchived": { "type": "boolean", "description": "An indication of whether the job record is archived or not.", "example": false }, "startTimeLocal": { "type": "string", "description": "The start time for the job in 24-hour local time. This property is specific to Avionté 24/7.", "example": "08:00" }, "endTimeLocal": { "type": "string", "description": "The end time for the job in 24-hour local time. This property is specific to Avionté 24/7.", "example": "17:00" }, "shiftScheduleDays": { "description": "Object that contains Shift Days. This property is specific to Avionté 24/7.", "oneOf": [ { "$ref": "#/components/schemas/front_office__ShiftScheduleDays" } ] }, "offer": { "type": "boolean", "description": "An indication of whether a job offer has been made or not. This property is specific to Avionté 24/7.", "example": false }, "pickList": { "type": "boolean", "description": "An indication of whether the job is of a Pick List type or not. This property is specific to Avionté 24/7.", "example": false }, "postJobToMobileApp": { "type": "boolean", "description": "An indication of whether the job should be posted on the mobile application. This property is specific to Avionté 24/7.", "example": true }, "payPeriod": { "description": "The pay period available for the job.", "example": "Weekly", "oneOf": [ { "$ref": "#/components/schemas/front_office__PayPeriod" } ] }, "bundled": { "type": "boolean", "description": "An indication of whether workers can pick up one job. This property is specific to Avionté 24/7.", "example": false }, "scheduleLengthWeeks": { "type": "integer", "description": "The identifier for Weeks in a Schedule.", "format": "int32", "example": 4 }, "scheduleShifts": { "type": "array", "description": "The list of Schedule Shifts per schedule weeks. This property is specific to Avionté 24/7.", "items": { "type": "object", "description": "front_office__JobScheduleShiftDto (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "mobileJobTitle": { "type": "string", "description": "The job title for mobile applications.", "example": "Software Engineer" }, "timeCaptureMethod": { "type": "string", "description": "The time capture method for this job. Indicates how talent should log their time.", "example": "TIMESHEET", "enum": [ "TIMESHEET", "DAILY_TIME", "GROUP_TIME", "BATCH_HOURS", "MOBILE_PUNCH" ] }, "flsaClassification": { "type": "string", "description": "The Fair Labor Standards Act (FLSA) classification for the Job, which determines the talent's eligibility for overtime pay. Valid values are `Exempt`, `NonExempt`, and `None`.", "example": "Exempt", "enum": [ "Exempt", "NonExempt", "None" ] }, "workScheduleType": { "type": "string", "description": "The expected work schedule for the job. Valid values are `Full-Time`, `Part-Time`, `Intermittent`, and `None`.", "example": "Full-Time", "enum": [ "Full-Time", "Part-Time", "Intermittent", "None" ] } }, "additionalProperties": false }, "front_office__Job": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 188499 }, "positions": { "type": "integer", "description": "The number of job positions.", "format": "int32", "example": 5 }, "startDate": { "type": "string", "description": "The estimated start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "endDate": { "type": "string", "description": "The estimated end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "payRates": { "description": "Information about the pay rates.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Rate" } ] }, "billRates": { "description": "Information about the bill rates.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Rate" } ] }, "title": { "maxLength": 500, "minLength": 1, "type": "string", "description": "The job title.", "example": "Warehouse Worker" }, "standardJobTitleId": { "type": "integer", "description": "The identifier for the standard job title." }, "standardJobTitle": { "type": "string", "description": "The standard job title." }, "socCode": { "type": "string", "description": "The Standard Occupational Classification (SOC) code mapped to the standard job title in the Table Editor. SOC codes are only used for U.S. jobs." }, "socCodeTitle": { "type": "string", "description": "The Standard Occupational Classification (SOC) title mapped to the standard job title in the Table Editor. SOC codes are only used for U.S. jobs." }, "costCenter": { "maxLength": 50, "type": "string", "description": "The company's cost center.", "example": "Center A" }, "employeeType": { "description": "The type of employment.", "example": "Temporary", "oneOf": [ { "$ref": "#/components/schemas/front_office__EmploymentType" } ] }, "workersCompensationClassCode": { "maxLength": 50, "type": "string", "description": "The worker's compensation class code.", "example": "4136" }, "workerCompCode": { "description": "Information about the worker's comp code.", "oneOf": [ { "$ref": "#/components/schemas/front_office__WorkerCompCode" } ] }, "workerCompCodeId": { "type": "integer", "description": "The identifier of the worker's comp code.", "format": "int32", "example": 138 }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 17845 }, "branchId": { "type": "integer", "description": "The unique identifier for the job office or department.", "format": "int32", "example": 15377 }, "frontOfficeId": { "type": "integer", "description": "The identifier for the job's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.", "format": "int32", "example": 2774 }, "addressId": { "type": "integer", "description": "The identifier for the worksite address.", "format": "int32", "example": 17748 }, "worksiteAddress": { "description": "The worksite address.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "poId": { "type": "integer", "description": "The identifier for the purchase order.", "format": "int32", "example": 123456 }, "companyName": { "maxLength": 255, "type": "string", "description": "The name of the company that posted the job.", "example": "Acme Corporation" }, "link": { "type": "string", "description": "URL to the job profile.", "example": "https://abc.myavionte.com/app/#/job/123456" }, "contactId": { "type": "integer", "description": "The identifier for the contact.", "format": "int32", "example": 123456 }, "statusId": { "type": "integer", "description": "The identifier for the job status.", "format": "int32", "example": 147 }, "status": { "maxLength": 255, "type": "string", "description": "The job status.", "example": "Open" }, "posted": { "type": "boolean", "description": "An indication of whether the job has been posted or not.", "example": true }, "createdDate": { "type": "string", "description": "The date the job order was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "orderType": { "maxLength": 255, "type": "string", "description": "The job type.", "example": "Temporary" }, "orderTypeId": { "type": "integer", "description": "The identifier for the job type.", "format": "int32", "example": 128 }, "representativeUsers": { "type": "array", "description": "The user IDs of the representatives for the job.", "example": [ 123, 456 ], "items": { "type": "integer", "format": "int32" } }, "isArchived": { "type": "boolean", "description": "An indication of whether the job record is archived or not.", "example": false }, "oT_Type": { "type": "integer", "description": "The type of the overtime (1 - StraightTime, 2 - PaidAndBilledOT, 3 - PaidNotBilledOT).", "format": "int32", "example": 2 }, "enteredByUserId": { "type": "integer", "description": "The identifier for the user who entered the job record.", "format": "int32", "example": 17845 }, "enteredByUser": { "maxLength": 255, "type": "string", "description": "The email of the user who entered the job record.", "example": "user@example.com" }, "salesRepUserId": { "type": "integer", "description": "The identifier for the sales representative for the job.", "format": "int32", "example": 17845 }, "salesRepUser": { "maxLength": 255, "type": "string", "description": "The email of the sales representative for the job.", "example": "salesrep@example.com" }, "description": { "type": "string", "description": "The job description.", "example": "General warehouse duties including picking, packing, and shipping." }, "customJobDetails": { "type": "array", "description": "A list of custom job details.", "items": { "type": "object", "description": "front_office__CustomJobDetail (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "lastUpdatedDate": { "type": "string", "description": "The date of the most recent update to the job record. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "latestActivityDate": { "type": "string", "description": "The date of the latest job activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "latestActivityName": { "maxLength": 255, "type": "string", "description": "The name of the latest job activity.", "example": "On Hold" }, "hasNoEndDate": { "type": "boolean", "description": "An indication of whether the job has an end date or not.", "example": false }, "payPeriod": { "type": "string", "description": "The pay period for the job. Valid values are None, Weekly, BiWeekly, SemiMonthly, Monthly, Yearly, Hourly, and Daily.", "example": "Weekly" }, "placed": { "type": "integer", "description": "The number of hired talent.", "format": "int32", "example": 5 }, "overtimeRuleID": { "type": "integer", "description": "The identifier for the overtime rule.", "format": "int32", "example": 1284 }, "startTimeLocal": { "type": "string", "description": "The start time for the job in 24-hour local time. This property is specific to Avionté 24/7.", "example": "08:00" }, "endTimeLocal": { "type": "string", "description": "The end time for the job in 24-hour local time. This property is specific to Avionté 24/7.", "example": "17:00" }, "shiftScheduleDays": { "description": "Object that contains Shift Days. This property is specific to Avionté 24/7.", "oneOf": [ { "$ref": "#/components/schemas/front_office__ShiftScheduleDays" } ] }, "offer": { "type": "boolean", "description": "An indication of whether a job offer has been made or not. This property is specific to Avionté 24/7.", "example": false }, "pickList": { "type": "boolean", "description": "An indication of whether the job is of a Pick List type or not. This property is specific to Avionté 24/7.", "example": false }, "postJobToMobileApp": { "type": "boolean", "description": "An indication of whether the job should be posted on the mobile application. This property is specific to Avionté 24/7.", "example": true }, "origin": { "maxLength": 50, "type": "string", "description": "The partner or vendor that originated the request.", "example": "Partner XYZ" }, "worksiteAddressId": { "type": "integer", "description": "The identifier for the worksite address.", "format": "int32", "example": 1234 }, "ownerUserId": { "type": "integer", "description": "The identifier for the user who entered the job record.", "format": "int32", "example": 135678 }, "bundled": { "type": "boolean", "description": "An indication of whether workers can pick up one job. This property is specific to Avionté 24/7.", "example": false }, "startOfWeek": { "type": "string", "description": "The day of the week that marks the start of the job.", "example": "Monday" }, "shiftName": { "type": "string", "description": "Description of the configured job shift.", "example": "Day Shift" }, "scheduleLengthWeeks": { "type": "integer", "description": "The identifier for Weeks in a Schedule.", "format": "int32", "example": 4 }, "scheduleShifts": { "type": "array", "description": "The list of Schedule Shifts per schedule weeks. This property is specific to Avionté 24/7.", "items": { "type": "object", "description": "front_office__JobScheduleShift (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "notes": { "type": "string", "description": "The job notes.", "example": "This is a sample job note." }, "estimatedHours": { "type": "integer", "description": "The estimated amount of time the job requires.", "format": "int32", "example": 40 }, "targetBillRate": { "type": "number", "description": "The target bill rate for the job.", "format": "decimal", "example": 100 }, "targetPayRate": { "type": "number", "description": "The target pay rate for the job.", "format": "decimal", "example": 80 }, "expenseType": { "description": "Information about the expense type.", "example": "PaidAndBilled", "oneOf": [ { "$ref": "#/components/schemas/front_office__ExpenseType" } ] }, "useCustomOTRates": { "type": "boolean", "description": "A flag indicating custom overtime rates can be used.", "example": true }, "overtimeBillRate": { "type": "number", "description": "The overtime bill rate value.", "format": "decimal", "example": 120 }, "overtimePayRate": { "type": "number", "description": "The overtime pay rate value.", "format": "decimal", "example": 100 }, "doubletimeBillRate": { "type": "number", "description": "The double time bill rate value.", "format": "decimal", "example": 140 }, "doubletimePayRate": { "type": "number", "description": "The double time pay rate value.", "format": "decimal", "example": 120 }, "rateType": { "description": "The rate type for the job.", "example": "HourlyRate", "oneOf": [ { "$ref": "#/components/schemas/front_office__JobRateType" } ] }, "weekDuration": { "description": "The week duration option for the job.", "example": "MondayToSunday", "oneOf": [ { "$ref": "#/components/schemas/front_office__WeekDuration" } ] }, "markupPercentage": { "type": "number", "description": "The mark-up percentage value.", "format": "decimal", "example": 8 }, "billingManagerId": { "type": "integer", "description": "The identifier for the billing manager for the job.", "format": "int32", "example": 148724 }, "billingName": { "maxLength": 255, "type": "string", "description": "The name of the billing contact.", "example": "John Doe" }, "billingAddress1": { "maxLength": 255, "type": "string", "description": "Billing address, line 1.", "example": "123 Main Street" }, "billingAddress2": { "maxLength": 100, "type": "string", "description": "Billing address, line 2.", "example": "Suite 100" }, "billingCity": { "maxLength": 50, "type": "string", "description": "Billing city.", "example": "Eagan" }, "billingState": { "maxLength": 50, "type": "string", "description": "Billing state.", "example": "MN" }, "billingZip": { "maxLength": 50, "type": "string", "description": "Billing ZIP/postal code.", "example": "55121" }, "billingPhone": { "maxLength": 50, "type": "string", "description": "Billing contact phone.", "example": "651-555-1234" }, "billingEmail": { "maxLength": 100, "type": "string", "description": "Billing contact email.", "example": "john.doe@example.com" }, "billingTerm": { "description": "The billing term.", "example": "DueUponReceipt", "oneOf": [ { "$ref": "#/components/schemas/front_office__BillingTerm" } ] }, "placementFee": { "type": "number", "description": "The placement fee for the job.", "format": "decimal", "example": 25 }, "placementPercentage": { "type": "number", "description": "The placement percentage for the job.", "format": "float", "example": 5 }, "positionCategoryId": { "type": "integer", "description": "The identifier for the position category.", "format": "int32", "example": 247 }, "division": { "maxLength": 50, "type": "string", "description": "The company's division.", "example": "Employer ABC" }, "overtimeType": { "description": "Information about the overtime type.", "example": "PaidAndBilledOT", "oneOf": [ { "$ref": "#/components/schemas/front_office__OvertimeType" } ] }, "maxBillRate": { "type": "number", "description": "The maximum bill rate value.", "format": "decimal", "example": 150 }, "minBillRate": { "type": "number", "description": "The minimum bill rate value.", "format": "decimal", "example": 100 }, "maxPayRate": { "type": "number", "description": "The maximum pay rate value.", "format": "decimal", "example": 120 }, "minPayRate": { "type": "number", "description": "The minimum pay rate value.", "format": "decimal", "example": 80 }, "department": { "maxLength": 50, "type": "string", "description": "The company department name.", "example": "Warehouse" }, "mobileJobTitle": { "type": "string", "description": "The job title for mobile applications.", "example": "Software Engineer" }, "timeCaptureMethod": { "type": "string", "description": "The time capture method for this job. Indicates how talent should log their time.", "example": "TIMESHEET", "enum": [ "TIMESHEET", "DAILY_TIME", "GROUP_TIME", "BATCH_HOURS", "MOBILE_PUNCH" ] }, "customJobId": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The custom job identifier.", "example": "abc-123" }, "flsaClassification": { "type": "string", "description": "The Fair Labor Standards Act (FLSA) classification for the Job, which determines the talent's eligibility for overtime pay. Valid values are `Exempt`, `NonExempt`, and `None`.", "example": "Exempt", "enum": [ "Exempt", "NonExempt", "None" ] }, "workScheduleType": { "type": "string", "description": "The expected work schedule for the job. Valid values are `Full-Time`, `Part-Time`, `Intermittent`, and `None`.", "example": "Full-Time", "enum": [ "Full-Time", "Part-Time", "Intermittent", "None" ] } }, "additionalProperties": false }, "front_office__JobScheduleShift": { "allOf": [ { "$ref": "#/components/schemas/front_office__JobScheduleShiftBasicBase" }, { "type": "object", "additionalProperties": false } ] }, "front_office__JobRateType": { "type": "string", "description": "The rate types available for selection for a job.", "enum": [ "HourlyRate", "DailyRate" ] }, "front_office__VMSJobDTO": { "required": [ "branchId", "companyId", "contactId", "origin", "positions", "startDate", "title", "worksiteAddressId" ], "type": "object", "properties": { "vmsReqId": { "type": "integer", "description": "The identifier for the VMS job.", "format": "int32", "example": 123456 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 789012 }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 456789 }, "branchId": { "type": "integer", "description": "The identifier for the company branch or department.", "format": "int32", "example": 101112 }, "frontOfficeId": { "type": "integer", "description": "The identifier for the job's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.", "format": "int32", "example": 123456 }, "contactId": { "type": "integer", "description": "The identifier for the company contact.", "format": "int32", "example": 789012 }, "worksiteAddressId": { "type": "integer", "description": "The identifier for the worksite address.", "format": "int32", "example": 345678 }, "positions": { "type": "integer", "description": "The number of positions.", "format": "int32", "example": 5 }, "startDate": { "type": "string", "description": "The estimated start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "endDate": { "type": "string", "description": "The estimated end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "estimatedHours": { "type": "integer", "description": "The estimated amount of time the job requires.", "format": "int32", "example": 40 }, "targetBillRate": { "type": "number", "description": "The target bill rate for the job.", "format": "decimal", "example": 30 }, "targetPayRate": { "type": "number", "description": "The target pay rate for the job.", "format": "decimal", "example": 25 }, "overtimeType": { "description": "Information about the overtime type.", "example": "PaidAndBilledOT", "oneOf": [ { "$ref": "#/components/schemas/front_office__OvertimeType" } ] }, "expenseType": { "description": "Information about the expense type.", "example": "PaidAndBilled", "oneOf": [ { "$ref": "#/components/schemas/front_office__ExpenseType" } ] }, "overtimeRuleId": { "type": "integer", "description": "The identifier for the overtime rule.", "format": "int32", "example": 434 }, "useCustomOTRates": { "type": "boolean", "description": "A flag indicating custom overtime rates can be used.", "example": true }, "overtimeBillRate": { "type": "number", "description": "The overtime bill rate value.", "format": "decimal", "example": 45 }, "overtimePayRate": { "type": "number", "description": "The overtime pay rate value.", "format": "decimal", "example": 40 }, "doubletimeBillRate": { "type": "number", "description": "The double time bill rate value.", "format": "decimal", "example": 60 }, "doubletimePayRate": { "type": "number", "description": "The double time pay rate value.", "format": "decimal", "example": 50 }, "maxBillRate": { "type": "number", "description": "The maximum bill rate value.", "format": "decimal", "example": 100 }, "minBillRate": { "type": "number", "description": "The minimum bill rate value.", "format": "decimal", "example": 80 }, "maxPayRate": { "type": "number", "description": "The maximum pay rate value.", "format": "decimal", "example": 30 }, "minPayRate": { "type": "number", "description": "The minimum pay rate value.", "format": "decimal", "example": 25 }, "rateType": { "description": "The rate types for the job.", "example": "HourlyRate", "oneOf": [ { "$ref": "#/components/schemas/front_office__JobRateType" } ] }, "weekDuration": { "description": "The week duration options for the job.", "example": "MondayToSunday", "oneOf": [ { "$ref": "#/components/schemas/front_office__WeekDuration" } ] }, "markupPercentage": { "type": "number", "description": "The mark-up percentage value.", "format": "decimal", "example": 8 }, "billingManagerId": { "type": "integer", "description": "The identifier for the billing manager for the job.", "format": "int32", "example": 12345 }, "billingName": { "maxLength": 255, "type": "string", "description": "The name of the billing contact.", "example": "John Smith" }, "billingAddress1": { "maxLength": 255, "type": "string", "description": "Billing address, line 1.", "example": "123 Main St" }, "billingAddress2": { "maxLength": 100, "type": "string", "description": "Billing address, line 2.", "example": "Suite 100" }, "billingCity": { "maxLength": 50, "type": "string", "description": "Billing city.", "example": "Anytown" }, "billingState": { "maxLength": 50, "type": "string", "description": "Billing state.", "example": "CA" }, "billingZip": { "maxLength": 50, "type": "string", "description": "Billing ZIP/postal code.", "example": "90210" }, "billingPhone": { "maxLength": 50, "type": "string", "description": "Billing phone.", "example": "555-123-4567" }, "billingEmail": { "maxLength": 100, "type": "string", "description": "Billing email.", "example": "john.smith@example.com" }, "billingTerm": { "description": "The billing term.", "example": "DueUponReceipt", "oneOf": [ { "$ref": "#/components/schemas/front_office__BillingTerm" } ] }, "placementFee": { "type": "number", "description": "The placement fee for the job.", "format": "decimal", "example": 25 }, "placementPercentage": { "type": "number", "description": "The placement percentage for the job.", "format": "float", "example": 5 }, "title": { "maxLength": 500, "minLength": 1, "type": "string", "description": "The title for the job.", "example": "Warehouse Worker" }, "positionCategoryId": { "type": "integer", "description": "The identifier for the position category.", "format": "int32", "example": 123 }, "costCenter": { "maxLength": 50, "type": "string", "description": "The company's cost center.", "example": "CC12345" }, "division": { "maxLength": 50, "type": "string", "description": "The company's division.", "example": "Sales" }, "department": { "maxLength": 50, "type": "string", "description": "The company's department.", "example": "Logistics" }, "workerCompCodeId": { "type": "integer", "description": "The identifier for the worker's comp code.", "format": "int32", "example": 456 }, "statusId": { "type": "integer", "description": "The identifier for the job order status.", "format": "int32", "example": 789 }, "orderTypeId": { "type": "integer", "description": "The identifier for the job type.", "format": "int32", "example": 101 }, "salesRepUserId": { "type": "integer", "description": "The identifier for the sales representative user for the job.", "format": "int32", "example": 112233 }, "ownerUserId": { "type": "integer", "description": "The identifier for the user who created a job.", "format": "int32", "example": 123456 }, "description": { "type": "string", "description": "The job description.", "example": "This is a sample job description for a warehouse worker position." }, "descriptionHTML": { "type": "string", "description": "The HTML for job description.", "example": "

This is a sample job description for a warehouse worker position.

" }, "notes": { "type": "string", "description": "The job notes.", "example": "This is a sample job note." }, "customJobDetails": { "type": "array", "description": "A list of custom job details.", "items": { "$ref": "#/components/schemas/front_office__CustomJobDetail" } }, "origin": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The partner or vendor that originated the request.", "example": "Partner XYZ" }, "isArchived": { "type": "boolean", "description": "An indication of whether the job record is archived or not.", "example": false }, "startTimeLocal": { "type": "string", "description": "The start time for the job in 24-hour local time. This property is specific to Avionté 24/7.", "example": "08:00" }, "endTimeLocal": { "type": "string", "description": "The end time for the job in 24-hour local time. This property is specific to Avionté 24/7.", "example": "17:00" }, "shiftScheduleDays": { "description": "Object that contains Shift Days. This property is specific to Avionté 24/7.", "oneOf": [ { "$ref": "#/components/schemas/front_office__ShiftScheduleDays" } ] }, "offer": { "type": "boolean", "description": "An indication of whether a job offer has been made or not. This property is specific to Avionté 24/7.", "example": true }, "pickList": { "type": "boolean", "description": "An indication of whether the job is of a Pick List type or not. This property is specific to Avionté 24/7.", "example": false }, "postJobToMobileApp": { "type": "boolean", "description": "An indication of whether the job should be posted on the mobile application. This property is specific to Avionté 24/7.", "example": true }, "payPeriod": { "description": "The pay period available for a job.", "example": "Weekly", "oneOf": [ { "$ref": "#/components/schemas/front_office__PayPeriod" } ] }, "vmsNotes": { "type": "string", "description": "The notes related to the VMS job.", "example": "This is a sample VMS note." }, "maxSubmittal": { "type": "integer", "description": "The maximum number of submittals.", "format": "int32", "example": 10 }, "vendorJobReqID": { "maxLength": 50, "type": "string", "description": "The string identifier for the vendor job.", "example": "VMS-REQ-123456" }, "vmsName": { "type": "string", "description": "VMS provider name.", "example": "VMS Provider Inc." }, "vmsType": { "maxLength": 50, "type": "string", "description": "VMS type.", "example": "Direct" }, "statusName": { "maxLength": 255, "type": "string", "description": "The name for the job order status.", "example": "Open" }, "jobRequirements": { "type": "array", "description": "The requirements of the job.", "items": { "$ref": "#/components/schemas/front_office__JobRequirement" } }, "orderTypeName": { "maxLength": 255, "type": "string", "description": "The job type.", "example": "Temporary" }, "jobSkills": { "type": "array", "description": "The job skills of the job.", "items": { "$ref": "#/components/schemas/front_office__JobSkill" } }, "jobSkillResponse": { "description": "The job skills response of the job.", "oneOf": [ { "$ref": "#/components/schemas/front_office__JobSkillResponse" } ] }, "jobOwners": { "type": "array", "description": "The user IDs of the job owners.", "example": [ 123456, 789012 ], "items": { "type": "integer", "format": "int32" } }, "bundled": { "type": "boolean", "description": "An indication of whether workers can pick up one job. This property is specific to Avionté 24/7.", "example": false }, "vendorId": { "type": "integer", "description": "The identifier for the vendor for the job.", "format": "int32", "nullable": true, "example": 12345 }, "jobTemplateId": { "type": "integer", "description": "The identifier for the job order template to associate with this VMS job. Must belong to the same CompanyId.", "format": "int32", "nullable": true, "example": 12345 } }, "additionalProperties": false }, "front_office__JobRequirement": { "type": "object", "properties": { "requirementName": { "type": "string", "description": "The name for the job requirement.", "example": "Safety Training" }, "fieldType": { "type": "string", "description": "The field type for the job requirement, it should be Checkbox, Freetext or Dropdown." }, "isRequired": { "type": "boolean", "description": "An indication of whether the job requirement is required (true) or optional (false). Defaults to true for backward compatibility.", "example": true } }, "additionalProperties": false }, "bo_prod__RequestId": { "type": "string", "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "format": "uuid", "x-disabled-for-amazon-gateway": { "example": "63680b86-c7e0-4a36-ae4a-d0d481089aff" } }, "bo_prod__402BackOfficeSubscriptionRequiredResponseBody": { "type": "string", "x-disabled-for-amazon-gateway": { "example": "Active Back-Office service subscription required for requested functionality." } }, "bo_prod__ApiServiceResultError": { "type": "object", "properties": { "requestId": { "$ref": "#/components/schemas/bo_prod__RequestId" }, "errorKey": { "type": "string", "description": "An internal error key used for troubleshooting. Set when the exception is handled.", "x-disabled-for-amazon-gateway": { "example": "BoTal001" } }, "error": { "type": "string", "description": "An error message describing the issue.", "x-disabled-for-amazon-gateway": { "example": "The requested operation could not be completed." } }, "errorType": { "$ref": "#/components/schemas/bo_prod__ApiServiceResultErrorType" } } }, "bo_prod__ApiServiceResultErrorType": { "type": "string", "enum": [ "Failure", "AccessDenied", "Conflict", "Duplicate", "NotFound", "ValidationFailure" ] }, "bo_prod__ApiResultBadRequest": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/bo_prod__ApiServiceResultError" }, { "$ref": "#/components/schemas/bo_prod__ExternalSourceInvalidError" } ] }, "bo_prod__ApiResultNotFound": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/bo_prod__ExternalSourceIdNotFoundError" }, { "$ref": "#/components/schemas/bo_prod__ApiServiceResultNotFoundError" } ] }, "bo_prod__ApiServiceResultNotFoundError": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the record that was not found." } }, "x-disabled-for-amazon-gateway": { "example": { "id": "0f8fad5b-d9cb-469f-a165-70867728950e" } } }, "bo_prod__ExternalSourceInvalidError": { "type": "object", "properties": { "requestId": { "$ref": "#/components/schemas/bo_prod__RequestId" }, "externalIdSource": { "type": "string", "description": "The value provided for the external ID source.", "x-disabled-for-amazon-gateway": { "example": "BOLD" } }, "error": { "type": "string", "description": "An error message describing the issue.", "x-disabled-for-amazon-gateway": { "example": "Provided source is not supported." } } } }, "bo_prod__ExternalIdTypes": { "type": "string", "enum": [ "Branch", "Company", "Department", "Job", "Placement", "Supplier", "Talent", "TalentAccount", "User", "None" ] }, "bo_prod__ExternalSourceIdNotFoundError": { "type": "object", "properties": { "requestId": { "$ref": "#/components/schemas/bo_prod__RequestId" }, "externalIdType": { "$ref": "#/components/schemas/bo_prod__ExternalIdTypes" }, "externalIdSource": { "type": "string", "description": "The value provided for the external ID source." }, "externalId": { "type": "string", "description": "The value provided for the external ID." } }, "x-disabled-for-amazon-gateway": { "example": { "requestId": "63680b86-c7e0-4a36-ae4a-d0d481089aff", "externalIdType": "Branch", "externalIdSource": "BOLD", "externalId": "123" } } }, "bo_prod__TaxDetail": { "type": "object", "properties": { "employeeGuid": { "type": "string", "description": "The unique identifier for the Talent record, formatted as a UUID.", "format": "uuid", "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, "talentExternalId": { "type": "integer", "description": "The unique identifier for the Talent record in the external system, formatted as an integer.", "example": 10542 }, "employeeTaxGuid": { "type": "string", "description": "The unique identifier for the Talent Tax record, formatted as a UUID. Null for federal W-4 tax records.", "format": "uuid", "nullable": true, "example": "a7b8c9d0-1e2f-4a3b-4c5d-6e7f8091a2b3" }, "taxId": { "type": "integer", "description": "The unique identifier for the Tax Record.", "format": "int32", "nullable": true, "example": 3401 }, "taxName": { "type": "string", "description": "The name of the tax record.", "example": "Federal Income Tax" }, "taxTypeId": { "type": "integer", "description": "The unique identifier for the Tax Type record.", "format": "int32", "nullable": true, "example": 1 }, "taxType": { "type": "string", "description": "The type of tax, either federal or state.", "example": "Federal" }, "vertexTaxId": { "type": "integer", "description": "The unique identifier for the Vertex Tax record.", "format": "int32", "nullable": true, "example": 68 }, "taxFilingStatusId": { "type": "integer", "description": "The unique identifier for the Tax Filing Status.", "format": "int32", "nullable": true, "example": 2 }, "taxFilingStatusName": { "type": "string", "description": "The name of the tax filing status.", "example": "Single" }, "exemptions": { "type": "integer", "description": "The number of exemptions configured for this tax.", "format": "int32", "nullable": true, "example": 1 }, "dependents": { "type": "integer", "description": "The number of dependents configured for this tax.", "format": "int32", "nullable": true, "example": 2 }, "additionalWithholding": { "type": "number", "description": "A fixed amount of additional funds to withhold from the talent paycheck for this tax.", "format": "decimal", "example": 25 }, "fixedPercentage": { "type": "number", "description": "A fixed percentage amount to use for calculating the amount withheld for this tax.", "format": "decimal", "nullable": true, "example": 10 }, "fixedAmount": { "type": "number", "description": "A fixed amount to withhold for this tax.", "format": "decimal", "nullable": true, "example": 50 }, "active": { "type": "boolean", "description": "An indication of whether this tax is currently active.", "nullable": true, "example": true }, "isTaxExempt": { "type": "boolean", "description": "An indication of whether the talent is exempt from this tax.", "example": false }, "nrCert": { "type": "boolean", "description": "An indication of whether the talent has a non-resident certificate for this tax.", "nullable": true, "example": false }, "exemptionAmount": { "type": "number", "description": "The exemption amount for this tax. This value is only used for Canadian taxes.", "format": "decimal", "nullable": true, "example": 1500 }, "useDefaultExemptionAmount": { "type": "boolean", "description": "An indication of whether the talent will use the default exemption amount or the amount configured in the __exemptionAmount__ field. This value is only used for Canadian taxes.", "nullable": true, "example": true }, "prescribedZone": { "type": "number", "description": "The prescribed zone for the tax record. Applicable only to Canadian taxes.", "format": "decimal", "nullable": true, "example": 0 }, "hasLockInLetter": { "type": "boolean", "description": "An indication of whether the talent has an IRS lock-in letter.", "example": false }, "resident": { "type": "boolean", "description": "An indication of whether the talent is a resident of the state associated with this tax.", "nullable": true, "example": true }, "nonResident": { "type": "boolean", "description": "An indication of whether the talent is a non-resident of the state associated with this tax.", "nullable": true, "example": false }, "officeDivision": { "type": "string", "description": "The name of the division associated with this tax setup.", "example": "Midwest Division" }, "federalW4Id": { "type": "integer", "description": "The unique identifier for the federal W-4 row. This value will be non-null if the current tax record is U.S. federal income tax.", "format": "int32", "nullable": true, "example": 7788 }, "hasMultipleJobs": { "type": "boolean", "description": "An indication of whether this talent has multiple jobs.", "nullable": true, "example": false }, "qualifyingChildren": { "type": "number", "description": "The monetary amount associated with the number of qualifying children.", "format": "decimal", "nullable": true, "example": 2000 }, "otherDependents": { "type": "number", "description": "The monetary amount associated with the number of other dependents for the talent.", "format": "decimal", "nullable": true, "example": 500 }, "totalDependents": { "type": "number", "description": "The monetary amount representing the total number of dependents across all sources.", "format": "decimal", "nullable": true, "example": 2500 }, "otherIncome": { "type": "number", "description": "The amount of other income recorded for the talent.", "format": "decimal", "nullable": true, "example": 1000 }, "deductions": { "type": "number", "description": "The amount of deductions for the talent.", "format": "decimal", "nullable": true, "example": 3000 }, "firstWorkedDate": { "type": "string", "description": "The date the talent first worked at the current supplier. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "nullable": true, "example": "2025-01-15T00:00:00Z" }, "usWithholdingType": { "type": "string", "description": "The withholding type for U.S. taxes, either nonresident alien or citizen.", "example": "Citizen" }, "dateCompleted": { "type": "string", "description": "The date the federal W-4 form was submitted by the talent. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "nullable": true, "example": "2025-01-10T09:00:00Z" }, "dateEntered": { "type": "string", "description": "The date the talent tax row was entered into the Back Office database. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "nullable": true, "example": "2025-01-10T09:15:00Z" }, "stateCode": { "type": "string", "description": "The state code associated with this tax record.", "example": "MN" }, "revisionYear": { "type": "number", "description": "The W4 revision year for this tax record.", "format": "integer", "example": 2025 } } }, "bo_prod__AdditionalTax": { "type": "object", "properties": { "taxId": { "type": "integer", "description": "The unique identifier for the Tax.", "format": "int32", "nullable": true, "example": 3401 }, "taxFilingStatusId": { "type": "integer", "description": "The unique identifier for the selected Filing Status.", "format": "int32", "nullable": true, "example": 2 }, "dependents": { "type": "integer", "description": "The number of dependents to set up for this tax.", "format": "int32", "nullable": true, "example": 2 }, "exemptions": { "type": "integer", "description": "The number of exemptions to set up for this tax.", "format": "int32", "example": 1 }, "AdditionalWithholding": { "type": "number", "description": "A fixed amount of additional funds to withhold from the talent for this tax.", "format": "decimal", "example": 25 }, "hasMultipleJobs": { "type": "boolean", "description": "An indication of whether this talent has multiple jobs.", "example": false }, "qualifyingChildren": { "type": "number", "description": "A monetary amount associated with the number of qualifying children", "format": "decimal", "example": 2000 }, "otherDependents": { "type": "number", "description": "A monetary amount associated with the number of other dependents for the talent.", "format": "decimal", "nullable": true, "example": 500 }, "otherIncome": { "type": "number", "description": "The amount of the talent record's other income.", "format": "decimal", "example": 1000 }, "deductions": { "type": "number", "description": "The amount of deductions for the talent.", "format": "decimal", "example": 3000 } } }, "front_office__CompanyDTO": { "required": [ "frontOfficeId", "name", "origin" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 12345 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the company.", "example": "Acme Corporation" }, "mainAddress": { "description": "The main address of the company.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "frontOfficeId": { "type": "integer", "description": "The identifier for the company's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.", "format": "int32", "example": 12353 }, "link": { "maxLength": 255, "type": "string", "description": "The website of the company.", "example": "https://www.acmecorp.com" }, "isArchived": { "type": "boolean", "description": "An indication of whether the company record is archived or not.", "example": false }, "representativeUsers": { "type": "array", "description": "The IDs of the representatives who are working with the company.", "example": [ 123498, 123499 ], "items": { "type": "integer", "format": "int32" } }, "sourceName": { "maxLength": 255, "type": "string", "description": "The name of the company source.", "example": "Indeed" }, "statusId": { "type": "integer", "description": "The identifier for the company status.", "format": "int32", "example": 128 }, "status": { "maxLength": 255, "type": "string", "description": "The status of the company. When a new status value is passed, the status is added to the tenant's list of custom company statuses, else we match on the string value to an existing company status.", "example": "Active" }, "industry": { "maxLength": 100, "type": "string", "description": "The company industry.", "example": "Information Technology" }, "createdDate": { "type": "string", "description": "The date the company profile was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "origin": { "maxLength": 50, "type": "string", "description": "The partner or vendor that originated the request.", "example": "Acme Partner" }, "originRecordId": { "maxLength": 255, "type": "string", "description": "The identifier for the company that can be used to link the record within the originating system.", "example": "ACME-12345" }, "department": { "description": "The department object for company.", "oneOf": [ { "$ref": "#/components/schemas/front_office__DepartmentDTO" } ] }, "weekEndDay": { "type": "string", "description": "The Week End Day of the company. Valid values are 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', and 'Sunday'.", "example": "Friday" }, "payPeriod": { "type": "string", "description": "The Pay Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.", "example": "Weekly" }, "payCycle": { "type": "string", "description": "The Pay Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.", "example": "1" }, "billingPeriod": { "type": "string", "description": "The Billing Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.", "example": "BiWeekly" }, "billingCycle": { "type": "string", "description": "The Billing Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.", "example": "2" }, "isParent": { "type": "boolean", "description": "An indication of whether the company is a parent company.", "example": true }, "parentCompanyId": { "type": "integer", "description": "The identifier for the parent company if this company is a child.", "format": "int32", "example": 13839 }, "phoneNumber": { "maxLength": 255, "type": "string", "description": "The phone number for the company.", "example": "305-555-01472" } }, "additionalProperties": false }, "bo_prod__BillPeriod": { "type": "string", "description": "An option to define the billing frequency of billing processing.", "example": "Weekly", "enum": [ "Unknown", "Weekly", "BiWeekly", "Monthly", "SemiMonthly", "Daily", "Yearly", "Hourly" ] }, "bo_prod__BillPeriodCycle": { "type": "string", "description": "An option to define when billing processing occurs.", "example": "1", "enum": [ "1", "2", "3", "4", "LastWeek" ] }, "bo_prod__CompanyBillingPreferences": { "type": "object", "properties": { "companyGuid": { "type": "string", "description": "The unique identifier for the Company, formatted as a UUID.", "format": "uuid", "example": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22" }, "billingPeriod": { "$ref": "#/components/schemas/bo_prod__BillPeriod" }, "billingPeriodCycle": { "$ref": "#/components/schemas/bo_prod__BillPeriodCycle" }, "invoicePreferences": { "$ref": "#/components/schemas/bo_prod__InvoicePreferences" }, "statementLetterPreferences": { "$ref": "#/components/schemas/bo_prod__StatementLetterPreferences" } } }, "bo_prod__InvoicePreferences": { "type": "object", "properties": { "billToDepartmentGuid": { "type": "string", "description": "The unique identifier for the Bill To Department.", "format": "uuid", "nullable": true, "example": "83db44f4-daee-496d-ba89-c3ed98de057d" }, "paymentTermsOptionId": { "type": "integer", "description": "The identifier used to determine the invoice payment terms.", "format": "int32", "nullable": true, "example": 1 }, "invoiceStyleGuid": { "type": "string", "description": "The unique identifier for the invoice report style, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "e76d10eb-8ecc-4d0b-8c6c-173c133594ac" }, "separateInvoiceByOptionIds": { "type": "array", "description": "The option identifiers used to determine how to split billing transactions into separate invoices.", "example": [ 0 ], "items": { "type": "integer", "description": "The unique identifier of an invoice report preference option." } }, "groupInvoiceItemsByOptionIds": { "type": "array", "description": "The option identifiers used to determine how to group billing transactions in an invoice.", "example": [ 0 ], "items": { "type": "integer", "description": "The unique identifier for an invoice report grouping preference." } }, "sortInvoiceItemsByOptionIds": { "type": "array", "description": "The option identifiers used to determine how to sort billing transactions in an invoice.", "example": [ 0 ], "items": { "type": "integer", "description": "The unique identifier for an invoice report sorting preference." } }, "displayInvoiceItemsByOptionIds": { "type": "array", "description": "The option identifiers used to determine what is included for display in an invoice.", "example": [ 0 ], "items": { "type": "integer", "description": "The unique identifier for an invoice display preference." } }, "showDailyHours": { "type": "boolean", "description": "An indication of whether daily hours are included in the invoice display.", "nullable": true, "example": false }, "showTimeCard": { "type": "boolean", "description": "An indication of whether timecard details are included in the invoice.", "nullable": true, "example": false }, "showWebTimeCard": { "type": "boolean", "description": "An indication of whether Connect timesheets are included in the invoice.", "example": false }, "includePastInvoice": { "type": "boolean", "description": "An indication of whether references to past invoices are included.", "nullable": true, "example": false }, "maxInvoiceAmount": { "type": "number", "description": "The maximum invoice amount threshold. A warning is displayed during billing if the amount exceeds this value.", "nullable": true, "example": 1000.01 }, "printInvoice": { "type": "boolean", "description": "An indication of whether a copy of the invoice is printed.", "nullable": true, "example": false }, "emailInvoiceTo": { "type": "array", "description": "The list of recipient email addresses to send the invoice to.", "example": [ "user@example.com" ], "items": { "type": "string", "description": "The email address of the invoice recipient.", "format": "email" } } } }, "bo_prod__StatementLetterPreferences": { "type": "object", "properties": { "includeFinanceCharges": { "type": "boolean", "description": "An indication of whether finance charges are included.", "nullable": true, "example": false }, "financeChargePercent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The percentage rate used to calculate finance charges.", "format": "double", "nullable": true, "example": 1.5 }, "financeChargeGracePeriod": { "type": "integer", "description": "The identifier for the grace period option before finance charges apply.", "format": "int32", "nullable": true, "example": 30 }, "increaseBalanceAmountDue": { "type": "boolean", "description": "An indication of whether finance charges increase the balance amount due.", "nullable": true, "example": false }, "autoEmailMonthlyStatements": { "type": "boolean", "description": "An indication of whether monthly statements are automatically emailed.", "nullable": true, "example": false }, "dayOfMonthToSendStatements": { "type": "integer", "description": "The identifier for the day of the month when statements should be sent.", "format": "int32", "nullable": true, "example": 1 }, "emailStatementTo": { "type": "array", "description": "The list of recipient email addresses to send the statements to.", "example": [ "user@example.com" ], "items": { "type": "string", "description": "The email address of the monthly statement recipient.", "format": "email" } } } }, "back_office__CreateConfigChoiceProperties": { "type": "object", "properties": { "choiceCode": { "type": "string", "description": "The Config Choice name." }, "choiceCodeDesc": { "type": "string", "description": "The Config Choice description." }, "configChoiceCategoryId": { "type": "integer", "description": "The Config Choice category ID.", "format": "int32" }, "employerId": { "type": "integer", "description": "The BOLD employer unique identifier.", "format": "int32" } }, "additionalProperties": false }, "back_office__V2ConfigChoice": { "type": "object", "properties": { "configChoiceId": { "type": "integer", "format": "int32" }, "choiceCode": { "type": "string" }, "choiceCodeDesc": { "type": "string" }, "setupTable": { "type": "string" }, "configChoiceCategoryId": { "type": "integer", "format": "int32" }, "rootStaffingSupplierGuid": { "type": "string", "format": "guid" }, "configChoiceGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "enteredByUserGuid": { "type": "string", "format": "guid" }, "assignment": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2AssignmentBase" } }, "assignmentEndReasons": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2AssignmentBase" } }, "configChoiceNode": { "type": "array", "items": { "type": "object", "description": "back_office__V2ConfigChoiceNodeBase (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "contactMethod": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2ContactMethodBase" } }, "customer": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2CustomerBase" } }, "customerAddress": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2CustomerAddressBase" } }, "dateType": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2DateTypeBase" } }, "employee": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2EmployeeBase" } }, "employeeAddress": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2EmployeeAddressBase" } }, "staffingOrder": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2StaffingOrderBase" } }, "configChoiceCategory": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2ConfigChoiceCategoryBase" } ] }, "userType": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2UserTypeBase" } } }, "additionalProperties": false }, "back_office__V2AssignmentBase": { "type": "object", "properties": { "assignmentGuid": { "type": "string", "format": "guid" }, "assignmentId": { "type": "integer", "format": "int32" }, "staffingOrderGuid": { "type": "string", "format": "guid" }, "employeeGuid": { "type": "string", "format": "guid" }, "staffingSupplierSiteGuid": { "type": "string", "format": "guid" }, "performanceConfigChoiceId": { "type": "integer", "format": "int32" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "sunday": { "type": "boolean" }, "note": { "type": "string" }, "agencyGuid": { "type": "string", "format": "guid" }, "externalId": { "type": "string" }, "isW2": { "type": "boolean" }, "externalDb": { "type": "string" }, "userGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "customerMarkupGuid": { "type": "string", "format": "guid" }, "endReasonConfigChoiceId": { "type": "integer", "format": "int32" }, "assignmentTypeConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "configTransactionSplitPlanGuid": { "type": "string", "format": "guid" }, "payBasisConfigSystemChoiceID": { "type": "integer", "format": "int32" }, "endReasonConfigChoice": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2ConfigChoiceBase" } ] }, "performanceConfigChoice": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2ConfigChoiceBase" } ] } } }, "back_office__V2ConfigChoiceBase": { "type": "object", "properties": { "configChoiceId": { "type": "integer", "format": "int32" }, "choiceCode": { "type": "string" }, "choiceCodeDesc": { "type": "string" }, "setupTable": { "type": "string" }, "configChoiceCategoryId": { "type": "integer", "format": "int32" }, "rootStaffingSupplierGuid": { "type": "string", "format": "guid" }, "configChoiceGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "enteredByUserGuid": { "type": "string", "format": "guid" } } }, "back_office__V2ConfigChoiceNodeBase": { "type": "object", "properties": { "configChoiceNodeId": { "type": "integer", "format": "int32" }, "configChoiceId": { "type": "integer", "format": "int32" }, "nodeId": { "type": "integer", "format": "int32" }, "isVisible": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "configChoiceNodeGuid": { "type": "string", "format": "guid" }, "node": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2NodeBase" } ] } } }, "back_office__V2NodeBase": { "type": "object", "properties": { "nodeId": { "type": "integer", "format": "int32" }, "nodeDescription": { "type": "string" }, "nodeTypeId": { "type": "integer", "format": "int32" }, "parentNodeId": { "type": "integer", "format": "int32" }, "fkguid": { "type": "string", "format": "guid" } } }, "back_office__V2ContactMethodBase": { "type": "object", "properties": { "contactMethodGuid": { "type": "string", "format": "guid" }, "contactMethodId": { "type": "integer", "format": "int32" }, "fkguid": { "type": "string", "format": "guid" }, "contactMethodValue": { "type": "string" }, "active": { "type": "boolean" }, "description": { "type": "string" }, "configEditMaskTypeId": { "type": "integer", "format": "int32" }, "contactTypeConfigChoiceId": { "type": "integer", "format": "int32" }, "isPrimaryContactMethod": { "type": "boolean" }, "externalLabel": { "type": "string" }, "externalId": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "userGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "cellPhoneProviderConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "doNotText": { "type": "boolean" }, "contactTypeConfigChoice": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2ConfigChoiceBase" } ] } } }, "back_office__V2CustomerBase": { "type": "object", "properties": { "customerGuid": { "type": "string", "format": "guid" }, "customerId": { "type": "integer", "format": "int32" }, "parentGuid": { "type": "string", "format": "guid" }, "customerName": { "type": "string" }, "departmentName": { "type": "string" }, "rootCustomerGuid": { "type": "string", "format": "guid" }, "staffingSupplierSiteGuid": { "type": "string", "format": "guid" }, "customerStatusConfigChoiceId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string" }, "externalDb": { "type": "string" }, "externalLabel": { "type": "string" }, "userGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "customerRecordTypeConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "defaultPriority": { "type": "string" }, "defaultLineOfBusiness": { "type": "string" }, "customerSummary": { "type": "string" } } }, "back_office__V2CustomerAddressBase": { "type": "object", "properties": { "customerAddressGuid": { "type": "string", "format": "guid" }, "customerGuid": { "type": "string", "format": "guid" }, "addressGuid": { "type": "string", "format": "guid" }, "billingCode": { "type": "string" }, "active": { "type": "boolean" }, "direction": { "type": "string" }, "specialInstruction": { "type": "string" }, "addressTypeConfigChoiceId": { "type": "integer", "format": "int32" }, "shortName": { "type": "string" }, "attnTo": { "type": "string" }, "dressCode": { "type": "string" }, "configSalesTaxGuid": { "type": "string", "format": "guid" }, "userGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "addressGu": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2Address" } ] } } }, "back_office__V2Address": { "type": "object", "properties": { "addressGuid": { "type": "string", "format": "guid" }, "street1": { "type": "string" }, "street2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "addressId": { "type": "integer", "format": "int32" }, "geoCode": { "type": "string" }, "externalLabel": { "type": "string" }, "externalId": { "type": "string" }, "county": { "type": "string" }, "externalDb": { "type": "string" }, "countryCode": { "type": "string" }, "schoolDistrictCode": { "type": "string" }, "overRideGeoCode": { "type": "string" }, "isOverridingGeocode": { "type": "boolean" }, "inCareOf": { "type": "string" }, "fkguid": { "type": "string", "format": "guid" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "psdCode": { "type": "string" } } }, "back_office__V2DateTypeBase": { "type": "object", "properties": { "dateTypeGuid": { "type": "string", "format": "guid" }, "fkguid": { "type": "string", "format": "guid" }, "dateTypeConfigChoiceId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "userGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "dateTypeConfigChoice": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2ConfigChoiceBase" } ] } } }, "back_office__V2EmployeeBase": { "type": "object", "properties": { "employeeGuid": { "type": "string", "format": "guid" }, "employeeId": { "type": "integer", "format": "int32" }, "ssn": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "middleName": { "type": "string" }, "staffingSupplierSiteGuid": { "type": "string", "format": "guid" }, "onAssignment": { "type": "boolean" }, "employeeStatusConfigChoiceId": { "type": "integer", "format": "int32" }, "maritalStatus": { "type": "integer", "format": "int32" }, "federalExemptions": { "type": "integer", "format": "int32" }, "stateExemptions": { "type": "integer", "format": "int32" }, "agencyGuid": { "type": "string", "format": "guid" }, "externalId": { "type": "string" }, "nickName": { "type": "string" }, "employeeDipercent": { "type": "number", "format": "double" }, "isW2": { "type": "boolean" }, "externalDb": { "type": "string" }, "salutationConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "userGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "checkDeliveryConfigChoiceId": { "type": "integer", "format": "int32" }, "employeeRecordOriginConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "employeeRecordTypeConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "electronicW2": { "type": "boolean" }, "acaeligibilityConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "acastabilityEndDate": { "type": "string", "format": "date-time" }, "maidenName": { "type": "string" }, "previousAliases": { "type": "string" }, "languageCode": { "type": "string" }, "backgroundSummaryComments": { "type": "string" }, "additionalFederalWithholding": { "type": "number", "format": "decimal" }, "additionalStateWithholding": { "type": "number", "format": "decimal" }, "additionalCountyWithholding": { "type": "number", "format": "decimal" }, "lastParsedResumeDocumentGuid": { "type": "string", "format": "guid" }, "isAeroParsed": { "type": "boolean" }, "htmlResume": { "type": "string" }, "primaryIndustry": { "type": "string" }, "hireDate": { "type": "string", "format": "date-time" }, "rehireDate": { "type": "string", "format": "date-time" }, "terminationDate": { "type": "string", "format": "date-time" }, "availabilityDate": { "type": "string", "format": "date-time" } } }, "back_office__V2EmployeeAddressBase": { "type": "object", "properties": { "employeeAddressGuid": { "type": "string", "format": "guid" }, "addressGuid": { "type": "string", "format": "guid" }, "employeeGuid": { "type": "string", "format": "guid" }, "addressTypeConfigChoiceId": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "shortName": { "type": "string" }, "userGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "isPaymentCheckAddress": { "type": "boolean" }, "payeeName": { "type": "string" }, "addressGu": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2Address" } ] }, "addressTypeConfigChoice": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2ConfigChoiceBase" } ] } } }, "back_office__V2StaffingOrderBase": { "type": "object", "properties": { "staffingOrderGuid": { "type": "string", "format": "guid" }, "staffingOrderId": { "type": "integer", "format": "int32" }, "masterOrderId": { "type": "integer", "format": "int32" }, "customerGuid": { "type": "string", "format": "guid" }, "configSkillCodeId": { "type": "integer", "format": "int32" }, "positionDescription": { "type": "string" }, "customerAddressGuid": { "type": "string", "format": "guid" }, "staffingSupplierSiteGuid": { "type": "string", "format": "guid" }, "orderStatusConfigChoiceId": { "type": "integer", "format": "int32" }, "systemOrderType": { "type": "string" }, "isPostedToWeb": { "type": "boolean" }, "currencyTypeConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string" }, "externalDb": { "type": "string" }, "userGuid": { "type": "string", "format": "guid" }, "dateEntered": { "type": "string", "format": "date-time" }, "orderRecordTypeConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "orderRecordOriginConfigSystemChoiceId": { "type": "integer", "format": "int32" }, "orderTypeConfigChoiceId": { "type": "integer", "format": "int32" }, "autoUpdateOrderStatus": { "type": "boolean" }, "dateOpened": { "type": "string", "format": "date-time" }, "timeToFill": { "type": "integer", "format": "int64" }, "dateFilled": { "type": "string", "format": "date-time" } } }, "back_office__V2ConfigChoiceCategoryBase": { "type": "object", "properties": { "configChoiceCategoryId": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "description": { "type": "string" }, "isSystemChoice": { "type": "boolean" }, "configChoiceCategoryGuid": { "type": "string", "format": "guid" } } }, "back_office__V2UserTypeBase": { "type": "object", "properties": { "userTypeGuid": { "type": "string", "format": "guid" }, "fkguid": { "type": "string", "format": "guid" }, "userTypeConfigChoiceId": { "type": "integer", "format": "int32" }, "userGuid": { "type": "string", "format": "guid" }, "percentOfCommisionConfigChoiceId": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" }, "dateEntered": { "type": "string", "format": "date-time" }, "userTypeConfigChoice": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/back_office__V2ConfigChoiceBase" } ] } } }, "front_office__ContactActivity": { "allOf": [ { "$ref": "#/components/schemas/front_office__ActivityType" }, { "type": "object", "properties": { "activityDate": { "type": "string", "description": "The date of the activity.", "format": "date-time" }, "contactId": { "type": "integer", "description": "The identifier for the contact who logged the activity.", "format": "int32" }, "id": { "type": "integer", "description": "The identifier for the contact activity.", "format": "int32" }, "notes": { "type": "string", "description": "Notes on the contact activity." }, "userId": { "type": "integer", "description": "The identifier for the user who created the activity.", "format": "int32" }, "contactActivityDetailsDefinitionIds": { "type": "array", "description": "The list of identifiers for the contact activity details definitions associated with the activity.", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false } ] }, "front_office__ActivityType": { "required": [ "typeId" ], "type": "object", "properties": { "typeId": { "minimum": 1, "type": "integer", "description": "The identifier for the activity type.", "format": "int32", "example": 284 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the activity type.", "example": "Interview completed" }, "show_in": { "type": "integer", "description": "An indicator of which activity type group the current activity type should be included in. Allowed values: -2 for Archived Activities/Tasks, -1 for All Activities/Tasks, 0 for Custom Tasks/Activities, 1 for Activities, 2 for Tasks. A value of -2 cannot be submitted when creating an activity.", "format": "int32", "example": 1 } }, "additionalProperties": false }, "front_office__DepartmentAddressCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/front_office__DepartmentAddressRequest" }, { "required": [ "city", "country", "postalCode", "stateProvince", "street1" ], "type": "object" } ] }, "front_office__DepartmentAddressRequest": { "allOf": [ { "$ref": "#/components/schemas/front_office__Address" }, { "type": "object", "properties": { "addressId": { "type": "integer", "description": "The identifier for the department address.", "format": "int32", "example": 12345 }, "branchId": { "type": "integer", "description": "The identifier for the company branch or department.", "format": "int32", "example": 12346 }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 12347 }, "addressType": { "description": "Address type for the department address.", "oneOf": [ { "$ref": "#/components/schemas/front_office__DepartmentAddressType" } ] }, "phone": { "maxLength": 255, "type": "string", "description": "The department's phone number.", "example": "+1-555-123-4567" }, "archive": { "type": "boolean", "description": "An indication of whether the department address is archived or not.", "example": false }, "isDefault": { "type": "boolean", "description": "An indication of whether the department address is the default address for the department.", "example": true }, "origin": { "maxLength": 50, "type": "string", "description": "The origin of the address of the department.", "example": "Acme Partner" }, "salesTaxes": { "type": "array", "description": "Sales tax references to assign to this address. Each item requires only __configSalesTaxGUID__. A __null__ value indicates no change, while an empty array clears all sales taxes.", "items": { "$ref": "#/components/schemas/front_office__SalesTaxReference" } } }, "additionalProperties": false } ] }, "front_office__SalesTaxReference": { "type": "object", "properties": { "configSalesTaxGUID": { "type": "string", "description": "The unique identifier for the sales tax configuration.", "format": "uuid", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } }, "additionalProperties": false }, "bo_prod__BackOfficeIdentifierId": { "type": "integer", "description": "The unique identifier for the Back Office entity.", "example": 12345 }, "bo_prod__Extra": { "type": "object", "properties": { "extraValueId": { "type": "integer", "description": "The unique identifier for the Extra row in the Back Office database, formatted as an integer.", "nullable": true, "example": 4521 }, "optionId": { "type": "integer", "description": "The unique identifier for the Custom Setup Option Row that relates to the current extra row.", "nullable": true, "example": 87 }, "optionName": { "type": "string", "description": "The display name of the Extra value setup option.", "example": "T-Shirt Size" }, "category": { "type": "string", "description": "The category for the current Extra, as defined in the accompanying custom setup option property value.", "example": "Apparel" }, "value": { "type": "string", "description": "The actual value of the Extra, formatted as a string.", "example": "Large" } } }, "bo_prod__ExtraValuePostResponse": { "type": "object", "properties": { "extraValues": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__Extra" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__ExtraValueError" } } } }, "bo_prod__ExtraValueError": { "type": "object", "properties": { "extraValueId": { "type": "string", "description": "The unique identifier for the Extra value, formatted as a UUID", "format": "uuid", "example": "f6a7b8c9-0d1e-4f2a-3b4c-5d6e7f8091a2" }, "errorMessage": { "type": "string", "description": "Error message.", "example": "The provided customSetupOptionId does not exist." } } }, "bo_prod__ExtraValuePostBody": { "type": "object", "properties": { "customSetupOptionId": { "type": "integer", "description": "The unique identifier for the Setup Option.", "example": 87 }, "extraValueOptionValue": { "type": "string", "description": "The value set on the __ExtraValue__ table that corresponds to the provided __customSetupOptionId__.", "nullable": true, "example": "Large" } } }, "front_office__Status": { "type": "string", "enum": [ "Inactive", "Active" ] }, "front_office__HcmUser": { "required": [ "emailAddress", "firstName", "homeOfficeId", "lastName", "userTypeId" ], "type": "object", "properties": { "firstName": { "maxLength": 255, "type": "string", "description": "The user's first name.", "example": "John" }, "lastName": { "maxLength": 255, "type": "string", "description": "The user's last name.", "example": "Doe" }, "emailAddress": { "maxLength": 255, "type": "string", "description": "The user's primary email address.", "example": "john.doe@example.com" }, "homePhone": { "maxLength": 255, "type": "string", "description": "The user's home phone number.", "example": "555-123-4567" }, "workPhone": { "maxLength": 255, "type": "string", "description": "The user's work phone number.", "example": "555-987-6543" }, "mobilePhone": { "maxLength": 255, "type": "string", "description": "The user's mobile phone number.", "example": "555-555-5555" }, "faxPhone": { "maxLength": 255, "type": "string", "description": "The user's fax phone number.", "example": "555-111-2222" }, "street1": { "maxLength": 255, "type": "string", "description": "Street address, line 1.", "example": "123 Main Street" }, "street2": { "maxLength": 255, "type": "string", "description": "Street address, line 2.", "example": "Suite 100" }, "city": { "maxLength": 255, "type": "string", "description": "City.", "example": "St. Paul" }, "stateProvince": { "maxLength": 2, "type": "string", "description": "ISO 2-character code for the Province, State, or Region.", "example": "MN" }, "postalCode": { "maxLength": 50, "type": "string", "description": "ZIP/postal code.", "example": "55121" }, "country": { "maxLength": 2, "type": "string", "description": "A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., \"US\", not \"USA\"). For details, see the General Guidelines.", "example": "US" }, "homeOfficeId": { "type": "integer", "description": "The identifier of the user's home office.", "format": "int32", "example": 28925 }, "officeAccess": { "type": "array", "description": "A list of office IDs that the user has access to.", "example": [ 28925, 14587 ], "items": { "type": "integer", "format": "int32" } }, "userTypeId": { "type": "integer", "description": "The identifier for the user type of the user.", "format": "int32", "example": 145 }, "userGroups": { "type": "array", "description": "A list of user group IDs to which the user belongs.", "example": [ 12, 34 ], "items": { "type": "integer", "format": "int32" } }, "sendWelcomeEmail": { "type": "boolean", "description": "An indication of whether to send a welcome email to the user upon creation. This will default to false if not provided.", "example": true } }, "additionalProperties": false }, "front_office__ApiUser": { "type": "object", "properties": { "userId": { "type": "integer", "description": "The identifier for the user.", "format": "int32" }, "firstName": { "type": "string", "description": "The user's first name." }, "lastName": { "type": "string", "description": "The user's last name." }, "emailAddress": { "type": "string", "description": "The user's email address." }, "homePhone": { "type": "string", "description": "The user's home phone number." }, "workPhone": { "type": "string", "description": "The user's work phone number." }, "mobilePhone": { "type": "string", "description": "The user's mobile phone number." }, "faxPhone": { "type": "string", "description": "The user's fax phone number." }, "address": { "description": "The user's home address.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "officeName": { "type": "string", "description": "The name of the user's home office." }, "officeDivision": { "type": "string", "description": "The division of the user's home office." }, "officeRegion": { "type": "string", "description": "The region of the user's home office." }, "isArchived": { "type": "boolean", "description": "An indication of whether the user's record is archived or not." }, "createdDate": { "type": "string", "description": "The date when the user profile was created.", "format": "date-time" }, "lastUpdatedDate": { "type": "string", "description": "The date of the most recent update to the user profile.", "format": "date-time" }, "smsPhoneNumber": { "type": "string", "description": "The phone number to which SMS messages should be sent." }, "smsForwardingNumber": { "type": "string", "description": "The phone number to which SMS messages should be forwarded." }, "userType": { "type": "string", "description": "User type of the user" }, "entityId": { "type": "integer", "description": "The ID of the entity associated with the user.\nWhen User Type = HCM, it is the ID of the user\nWhen User Type = Manager or Contractor, it is the ID of that entity", "format": "int32" }, "email2": { "type": "string", "description": "The second email of the user." }, "status": { "description": "The active status of the user.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Status" } ] }, "homeOfficeId": { "type": "integer", "description": "The identifier of the user's home office.", "format": "int32", "example": 28925 }, "officeAccess": { "type": "array", "description": "A list of office IDs that the user has access to.", "example": [ 28925, 14587 ], "items": { "type": "integer", "format": "int32" } }, "userGroups": { "type": "array", "description": "A list of user group IDs to which the user belongs.", "example": [ 12, 34 ], "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "back_office__MappingTypeData": { "type": "object", "properties": { "mappingTypeDataGUID": { "type": "string", "format": "guid" }, "mappingTypeDataID": { "type": "integer", "format": "int32" }, "mappingTypeGUID": { "type": "string", "format": "guid" }, "mapFromID": { "type": "string" }, "mapToID": { "type": "string" }, "extra1": { "type": "string" }, "extra2": { "type": "string" }, "extra3": { "type": "string" }, "extra4": { "type": "string" }, "extra5": { "type": "string" } }, "additionalProperties": false }, "back_office__MappingTypeDataRequest": { "type": "object", "properties": { "mappingGroup": { "type": "string" }, "mappingTypeName": { "type": "string" }, "systemSourceValue": { "type": "string" } }, "additionalProperties": false }, "front_office__PartnerTaskRequest": { "required": [ "partnerTaskSpecificationId" ], "type": "object", "properties": { "partnerTaskSpecificationId": { "type": "integer", "description": "Identifier of the partner task specification (returned by the GET partner task specification endpoint) describing the task to assign to the talent.", "format": "int32", "example": 42 }, "taskDueDate": { "type": "string", "description": "Optional due date for the task. If the due date passes, the task is not automatically canceled; it remains active and moves to the *Overdue* bucket on the recruiter dashboard. If omitted, the task has no due date and will not appear in Overdue tracking.", "format": "date-time", "nullable": true, "example": "2026-06-30T23:59:59Z" }, "taskExternalId": { "type": "string", "description": "Optional reference identifier supplied by the partner to correlate this task with their own system.", "nullable": true, "example": "partner-ref-12345" } }, "additionalProperties": false }, "front_office__PartnerTaskResponse": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "Identifier of the newly created onboarding task record.", "format": "int32", "example": 98765 } }, "additionalProperties": false }, "front_office__FormW4FilingStatus": { "type": "string", "description": "Filing statuses available for selection for Form W-4.", "enum": [ "None", "Single", "Married", "MarriedWithHigherRate" ] }, "front_office__TalentDto": { "required": [ "emailAddress", "firstName", "lastName", "origin", "representativeUser" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 1367290 }, "firstName": { "maxLength": 255, "type": "string", "description": "The talent's first name.", "example": "John" }, "middleName": { "maxLength": 255, "type": "string", "description": "The talent's middle name.", "example": "David" }, "lastName": { "maxLength": 255, "type": "string", "description": "The talent's last name.", "example": "Smith" }, "homePhone": { "maxLength": 255, "type": "string", "description": "The talent's home phone.", "example": "651-555-1234" }, "workPhone": { "maxLength": 255, "type": "string", "description": "The talent's work phone.", "example": "(612)555-5678" }, "mobilePhone": { "maxLength": 255, "type": "string", "description": "The talent's mobile phone.", "example": "+16125559876" }, "emailAddress": { "maxLength": 255, "type": "string", "description": "The talent's email address.", "example": "jdsmith@example.com" }, "emailAddress2": { "maxLength": 255, "type": "string", "description": "The talent's second email address.", "example": "jdsmith2@example.com" }, "taxIdNumber": { "maxLength": 9, "minLength": 9, "type": "string", "description": "The numeric digits for the talent's Taxpayer Identification Number. It may be either the US SSN or the Canadian SIN. If the Canadian SIN is less than 9 digits, then 0's should be prepended to the number to reach 9 digits.", "example": "111223333" }, "birthday": { "type": "string", "description": "The talent's birthday. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2000-12-01 or 2000-12-01T00:00:00.", "format": "date-time" }, "gender": { "type": "string", "description": "The talent's gender. Valid values are \"M\" or \"Male\", \"F\" or \"Female\", \"N\" or \"Non-Binary\", \"X\" or \"I Do Not Wish To Answer\".", "example": "M" }, "residentAddress": { "description": "The talent's home address.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "payrollAddress": { "description": "The talent's payroll mailing address.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "frontOfficeId": { "type": "integer", "description": "The identifier for the talent’s home office/branch. It occupies the following position in the Front Office hierarchy: Division > Region > Office/Branch.", "format": "int32", "example": 111 }, "race": { "maxLength": 255, "type": "string", "description": "The talent's race. Valid values are: \n\n American Indian or Alaska Native, \n\n Asian (Not Hispanic or Latino), \n\n Black or African American (Not Hispanic or Latino), \n\n Hispanic or Latino, Native Hawaiian or Other Pacific Islander, \n\n Two or More Races (Not Hispanic or Latino), \n\n White (Not Hispanic or Latino), \n\n I do not wish to answer.", "example": "White (Not Hispanic or Latino)" }, "disability": { "maxLength": 255, "type": "string", "description": "The talent's disability status. Valid values are: \n\n Individual with Disabilities \n\n Individual without Disabilities \n\n I do not wish to answer.", "example": "Individual without Disabilities" }, "veteranStatus": { "maxLength": 255, "type": "string", "description": "The talent's veteran status. Valid values are: \n\n Armed Forces Services Medal Veteran \n\n Disabled Veteran \n\n Non Veteran \n\n Other Protected Veteran \n\n Recently Separated Veteran \n\n Active Wartime or Campaign Badge Veteran \n\n I do not wish to answer.", "example": "Non Veteran" }, "representativeUser": { "type": "integer", "description": "The user ID of the representative who is working with the talent.", "format": "int32", "example": 14029 }, "w2Consent": { "type": "boolean", "description": "An indication of whether the talent has consented to receive the W-2 form electronically.", "example": true }, "availabilityDate": { "type": "string", "description": "The date the talent is available for work. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "statusId": { "type": "integer", "description": "The identifier for the talent's status.", "format": "int32", "example": 263 }, "createdDate": { "type": "string", "description": "The date the talent profile was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "lastUpdatedDate": { "type": "string", "description": "The date of the most recent update to the talent profile. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "flag": { "maxLength": 50, "type": "string", "description": "An indication of whether the talent profile is flagged. If flagged, the value should be specified as Green, Yellow or Red.", "example": "Green" }, "origin": { "maxLength": 50, "type": "string", "description": "The partner or vendor that originated the request. \"API\" will be appended by Avionté.", "example": "A+ Partner" }, "originRecordId": { "maxLength": 255, "type": "string", "description": "The identifier for the talent that can be used to link the record within the originating system.", "example": "142A8E" }, "officeName": { "maxLength": 255, "type": "string", "description": "The name of the talent's home office/branch.", "example": "Branch A" }, "officeDivision": { "maxLength": 255, "type": "string", "description": "The division of the talent's home office/branch.", "example": "ABC Staffing" }, "status": { "maxLength": 50, "type": "string", "description": "The status of the talent that can be passed in if the statusId is not known. When a new status value is passed, the status is added to the tenant's list of custom talent statuses, else we match on the string value to an existing talent status.", "example": "Active" }, "textConsent": { "maxLength": 50, "type": "string", "description": "The talent's consent status for receiving text messages. Acceptable Values are \"Opt Out\", \"Opt In\", and \"No Response\".", "example": "Opt In" }, "talentResume": { "description": "Resume of the talent.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Resume" } ] }, "hireDate": { "type": "string", "description": "The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "terminationDate": { "type": "string", "description": "The talent's date of termination with the staffing agency. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "rehireDate": { "type": "string", "description": "The talent's date of rehire with the staffing agency. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "employmentTypeId": { "type": "integer", "description": "The identifier for the talent's employment type which can represent a custom W-2, 1099, or C2C value.", "format": "int32", "example": 343 }, "isGeneralApply": { "type": "boolean", "description": "An indication of whether the talent was submitted through General Apply.", "example": false }, "travelRadius": { "type": "integer", "description": "The maximum distance in miles the talent is willing to travel for work.", "format": "int32", "example": 25 } }, "additionalProperties": false }, "front_office__Talent": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 1367290 }, "firstName": { "maxLength": 255, "type": "string", "description": "The talent's first name.", "example": "John" }, "middleName": { "maxLength": 255, "type": "string", "description": "The talent's middle name.", "example": "David" }, "lastName": { "maxLength": 255, "type": "string", "description": "The talent's last name.", "example": "Smith" }, "homePhone": { "maxLength": 255, "type": "string", "description": "The talent's home phone.", "example": "651-555-1234" }, "workPhone": { "maxLength": 255, "type": "string", "description": "The talent's work phone.", "example": "612-555-5678" }, "mobilePhone": { "maxLength": 255, "type": "string", "description": "The talent's mobile phone.", "example": "+16125559876" }, "pagerNumber": { "maxLength": 255, "type": "string", "description": "The talent's pager number.", "example": "(612) 555-4321" }, "emailAddress": { "maxLength": 255, "type": "string", "description": "The talent's email address.", "example": "jdsmith@example.com" }, "emailAddress2": { "maxLength": 255, "type": "string", "description": "The talent's second email address.", "example": "jdsmith2@example.com" }, "taxIdNumber": { "maxLength": 9, "minLength": 9, "type": "string", "description": "The numeric digits for the talent's Taxpayer Identification Number. It may be either the US SSN or the Canadian SIN. If the Canadian SIN is less than 9 digits, then 0's will be prepended to the number to reach 9 digits.", "example": "111223333" }, "birthday": { "type": "string", "description": "The talent's birthday. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2000-12-01 or 2000-12-01T00:00:00.", "format": "date-time" }, "gender": { "type": "string", "description": "The talent's gender. Valid values are \"M\" or \"Male\", \"F\" or \"Female\", \"N\" or \"Non-Binary\", \"X\" or \"I Do Not Wish To Answer\".", "example": "M" }, "hireDate": { "type": "string", "description": "The talent's date of hire with the staffing agency. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "residentAddress": { "description": "The talent's home address.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "mailingAddress": { "description": "The talent's mailing address.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "payrollAddress": { "description": "The talent's payroll mailing address.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "addresses": { "type": "array", "description": "An address array containing only the talent's home address.", "items": { "type": "object", "description": "front_office__Address (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "status": { "maxLength": 50, "type": "string", "description": "The talent's status.", "example": "Active" }, "filingStatus": { "description": "The talent's tax filing status.", "example": "Single", "oneOf": [ { "$ref": "#/components/schemas/front_office__FormW4FilingStatus" } ] }, "federalAllowances": { "type": "integer", "description": "Federal withholding exemptions.", "format": "int32", "example": 1 }, "stateAllowances": { "type": "integer", "description": "State withholding exemptions.", "format": "int32", "example": 1 }, "additionalFederalWithholding": { "type": "number", "description": "Additional amount of money that is withheld from the talent's each paycheck based on the talent's request.", "format": "decimal", "example": 100.5 }, "i9ValidatedDate": { "type": "string", "description": "The date the talent's I-9 document was verified. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00. ", "format": "date-time" }, "frontOfficeId": { "type": "integer", "description": "The identifier for the talent’s home office/branch. It occupies the following position in the Front Office hierarchy: Division > Region > Office/Branch.", "format": "int32", "example": 111 }, "latestActivityDate": { "type": "string", "description": "The date of the talent's latest activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. If the timestamp includes a Z (e.g., YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ), it indicates UTC time. For example, 2024-12-01, 2024-12-01T14:30:00, 2024-12-01T14:30:00.546, 2024-12-01T14:30:00Z, and 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2025-01-01T20:32:02.447Z" }, "latestActivityName": { "maxLength": 255, "type": "string", "description": "The talent's latest activity type.", "example": "Interview" }, "link": { "type": "string", "description": "URL to the talent profile.", "example": "http://example.myavionte.com/app/#/applicant/1367290" }, "race": { "maxLength": 255, "type": "string", "description": "The talent's race. Valid values are \n\n American Indian or Alaska Native, \n\n Asian (Not Hispanic or Latino), \n\n Black or African American (Not Hispanic or Latino), \n\n Hispanic or Latino, Native Hawaiian or Other Pacific Islander, \n\n Two or More Races (Not Hispanic or Latino), \n\n White (Not Hispanic or Latino), \n\n I do not wish to answer.", "example": "White (Not Hispanic or Latino)" }, "disability": { "maxLength": 255, "type": "string", "description": "The talent's disability status. Valid values are \n\n Individual with Disabilities \n\n Individual without Disabilities \n\n I do not wish to answer ", "example": "Individual without Disabilities" }, "veteranStatus": { "maxLength": 255, "type": "string", "description": "The talent's veteran status. Valid values are \n\n Armed Forces Services Medal Veteran \n\n Disabled Veteran \n\n Non Veteran \n\n Other Protected Veteran \n\n Recently Separated Veteran \n\n Active Wartime or Campaign Badge Veteran \n\n I do not wish to answer", "example": "Non Veteran" }, "emailOptOut": { "type": "boolean", "description": "An indication of whether the talent has opted out of receiving emails from Avionté BOLD or not.", "example": false }, "isArchived": { "type": "boolean", "description": "An indication of whether the talent record is archived or not.", "example": false }, "placementStatus": { "type": "string", "description": "The talent's current placement status. Possible values are: \"Active Contractor\", \"Permanently Placed\", \"Not Active Contractor\".", "example": "Active Contractor" }, "representativeUser": { "type": "integer", "description": "The user ID of the representative who is working with the talent.", "format": "int32", "example": 14029 }, "w2Consent": { "type": "boolean", "description": "An indication of whether the talent has consented to receive the W-2 form electronically or not.", "example": true }, "electronic1095CConsent": { "type": "boolean", "description": "An indication of whether the talent has consented to receive the 1095-C form electronically or not.", "example": true }, "referredBy": { "type": "string", "description": "A comma-delimited list of usernames who referred the talent, with each name followed by an indicator specifying the type of user (Applicant or Contact).", "example": "Stephanie Tester (Applicant), Tim Manager (Contact)" }, "availabilityDate": { "type": "string", "description": "The date when the talent is available for work. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "statusId": { "type": "integer", "description": "The talent's status ID.", "format": "int32", "example": 263 }, "officeName": { "maxLength": 255, "type": "string", "description": "The name of the talent's home office/branch.", "example": "Branch A" }, "officeDivision": { "maxLength": 255, "type": "string", "description": "The division of the talent's home office/branch.", "example": "ABC Staffing" }, "enteredByUserId": { "type": "integer", "description": "The ID of the user who entered the talent record.", "format": "int32", "example": 19842 }, "enteredByUser": { "maxLength": 255, "type": "string", "description": "The email of the user who entered the talent record.", "example": "jrecruiter@abc.com" }, "representativeUserEmail": { "maxLength": 255, "type": "string", "description": "The email of talent's representative user.", "example": "repuser123@abc.com" }, "createdDate": { "type": "string", "description": "The date the talent profile was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "lastUpdatedDate": { "type": "string", "description": "The date of the most recent update to the talent profile. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "latestWork": { "maxLength": 255, "type": "string", "description": "The most recent employment of the talent (company - position).", "example": "Company XYZ - General Laborer" }, "lastContacted": { "type": "string", "description": "The date the talent was last contacted via the Send Email option on their profile. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-01T14:30:00Z or 2024-12-01T14:30:00.1234567+00:00.", "format": "date-time" }, "flag": { "maxLength": 50, "type": "string", "description": "An indication of whether the talent profile is flagged. If flagged, the value is specified as Green, Yellow or Red or \"\" for cases when an empty value is selected.", "example": "Green" }, "origin": { "maxLength": 50, "type": "string", "description": "The partner or vendor that originated the request. \"API\" is appended by Avionté.", "example": "A+ PartnerAPI" }, "originRecordId": { "maxLength": 255, "type": "string", "description": "The identifier for the talent that can be used to link the record within the originating system.", "example": "142A8E" }, "electronic1099Consent": { "type": "boolean", "description": "An indication of whether the talent has consented to the electronic delivery of forms or not.", "example": true }, "textConsent": { "maxLength": 50, "type": "string", "description": "The talent's consent status for receiving text messages. Acceptable Values are \"Opt Out\", \"Opt In\", and \"No Response\".", "example": "Opt In" }, "talentResume": { "description": "Resume of the talent.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Resume" } ] }, "rehireDate": { "type": "string", "description": "The talent's date of rehire with the staffing agency. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "terminationDate": { "type": "string", "description": "The talent's date of termination with the staffing agency. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "employmentTypeId": { "type": "integer", "description": "The identifier for the talent's employment type which can represent a custom W-2, 1099, or C2C value.", "format": "int32", "example": 343 }, "employmentType": { "maxLength": 15, "type": "string", "description": "The type of employment associated to the talent's custom employment type value which can be either W-2, 1099, or C2C.", "example": "W-2" }, "employmentTypeName": { "maxLength": 50, "type": "string", "description": "The talent's custom employment type value.", "example": "Custom W2" }, "travelRadius": { "type": "integer", "description": "The maximum distance in miles the talent is willing to travel for work.", "format": "int32", "example": 25 } }, "additionalProperties": false }, "front_office__Resume": { "type": "object", "properties": { "resumeFilename": { "maxLength": 500, "type": "string", "description": "The file name for the resume that was uploaded.", "example": "John Smith Resume.docx" }, "resumeText": { "type": "string", "description": "Raw text of a resume if a file was not uploaded.", "example": "John Doe, JR. 918 Reese Avenue Huntingdon Valley, PA 19006(215) 817-1234jdoe528@comcast.net\\ \\ QUALIFICATIONS PROFILE 11 years of experience in managing distribution center operations.\\ \\ Solid track record of leadership and\\change management strategies yielding dramatic increases in \\ \\customer satisfaction, operational efficiency, and cost containment." }, "resumeContents": { "type": "string", "description": "The contents of the uploaded resume file passed as Base64 string content. Contents in this property will supersede any raw resume text that is passed in the ResumeText property.", "example": "Base-64 Encoded string" } }, "additionalProperties": false }, "bo_prod__TalentAccrualManualEntryRequest": { "type": "object", "properties": { "talentAccrualGuid": { "type": "string", "description": "The unique identifier for the Talent Accrual record.", "format": "uuid", "example": "d0e1f2a3-4b5c-4d6e-7f80-91a2b3c4d5e6" }, "accruedUnit": { "type": "number", "description": "The number of units for the manual entry. Can be either a positive or negative value.", "format": "decimal", "example": 8 }, "effectiveDate": { "type": "string", "description": "The effective date for the accrued units on this manual entry. This date is used to determine which accrual period the units should apply to. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format, for example, 2026-12-01 or 2026-12-01T14:30:00.", "format": "date-time", "nullable": true, "example": "2026-12-01T00:00:00Z" }, "excludeFromLimitCalculation": { "type": "boolean", "description": "An indication of whether manual units are excluded from the various limits associated with the plan. When set to `true`, the units do not count toward yearly or pay period limits.", "example": false }, "note": { "type": "string", "description": "A free-text note field associated with the manually entered hours.", "example": "Manual accrual adjustment" } } }, "front_office__TalentActivity": { "allOf": [ { "$ref": "#/components/schemas/front_office__ActivityType" }, { "required": [ "talentId" ], "type": "object", "properties": { "activityDate": { "type": "string", "description": "The date of the talent's activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. If the timestamp includes a Z (e.g., YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ), it indicates UTC time. For example, 2024-12-01, 2024-12-01T14:30:00, 2024-12-01T14:30:00.546, 2024-12-01T14:30:00Z, and 2024-12-01T14:30:00.546Z.", "format": "date-time" }, "talentId": { "minimum": 1, "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 283287 }, "id": { "type": "integer", "description": "The identifier for the talent activity.", "format": "int32", "example": 53892 }, "notes": { "type": "string", "description": "The talent activity notes.", "example": "Need to call." }, "userId": { "type": "integer", "description": "The identifier for the user who logged the activity.", "format": "int32", "example": 42948 } }, "additionalProperties": false } ] }, "front_office__TalentJobActivity": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent job activity.", "format": "int32" }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32" }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "activityDate": { "type": "string", "description": "The date of the activity.", "format": "date-time" }, "note": { "type": "string", "description": "The talent job activity notes." }, "userId": { "type": "integer", "description": "The identifier for the user who logged the activity.", "format": "int32" }, "typeId": { "type": "integer", "description": "The identifier for the activity type.", "format": "int32" }, "name": { "type": "string", "description": "The name of the talent job activity." } }, "additionalProperties": false }, "front_office__ArrayOfTalentResumeSkill": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentResumeSkill" } }, "front_office__TalentResumeSkill": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the resume skill for the talent.", "format": "int32", "example": 12499 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 183489 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the resume skill.", "example": "Communication Skills" }, "value": { "type": "integer", "description": "The strength of the resume skill on a scale of 1 to 5.", "format": "int32", "example": 3 } }, "additionalProperties": false }, "front_office__TalentResumeSkillResponse": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the resume skill for the talent.", "format": "int32", "example": 28925 }, "name": { "type": "string", "description": "The name of the resume skill.", "nullable": true }, "value": { "type": "integer", "description": "The value of the resume skill.", "format": "int32", "nullable": true, "example": 1328925 } }, "additionalProperties": false }, "front_office__TalentResumeSkillsResponse": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "talentResumeSkills": { "type": "array", "description": "A list of talent resume skills.", "nullable": true, "items": { "$ref": "#/components/schemas/front_office__TalentResumeSkillResponse" } } }, "additionalProperties": false }, "bo_prod__TaxCountyDetailResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/bo_prod__TaxCountyDetail" }, { "$ref": "#/components/schemas/bo_prod__TaxCountyName" } ] }, "bo_prod__TaxCountyDetail": { "type": "object", "properties": { "employeeTaxCountyId": { "type": "integer", "description": "The unique identifier for the Talent Tax County Setup data.", "nullable": true, "example": 5567 }, "year": { "type": "integer", "description": "The year associated with the tax county data.", "format": "int32", "example": 2025 }, "residentCountyGeocode": { "type": "string", "description": "The first five digits of the geocode that represents the selected county.", "example": "24031" }, "worksiteCountyGeocode": { "type": "string", "description": "The first five digits of the geocode that represents the selected county.", "example": "24033" } } }, "bo_prod__TaxCountyName": { "type": "object", "properties": { "residentCountyName": { "type": "string", "description": "The plain-text name of the resident county.", "example": "Montgomery" }, "worksiteCountyName": { "type": "string", "description": "The plain-text name of the worksite county.", "example": "Prince George's" } } }, "bo_prod__TaxCountyDetailRequest": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/bo_prod__TaxCountyDetail" } ] }, "front_office__TalentUser": { "allOf": [ { "$ref": "#/components/schemas/front_office__ApiUser" }, { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "isAuth0UserCreationInProgress": { "type": "boolean", "description": "An indication of whether Auth0 user creation is in progress." } }, "additionalProperties": false } ] }, "front_office__TalentUserRequest": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "legacyWorkN": { "type": "boolean", "description": "The flag for legacy WorkN authentication." } }, "additionalProperties": false }, "front_office__TalentWorkHistory": { "required": [ "talentId" ], "type": "object", "properties": { "workHistoryID": { "type": "integer", "description": "The identifier for the talent work history record.", "format": "int32", "example": 29184 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 183744 }, "company": { "maxLength": 255, "type": "string", "description": "The name of the company where the talent worked.", "example": "ABC Corp" }, "title": { "maxLength": 255, "type": "string", "description": "The job title.", "example": "Warehouse Worker" }, "from": { "maxLength": 50, "type": "string", "description": "The employment start date. This is an open-format text field containing the year, and possibly month of the date. For example, 2012, 9/12, 09-2012.", "example": "9/2012" }, "to": { "maxLength": 50, "type": "string", "description": "The employment end date. This is an open-format text field containing the year, and possibly month of the date. For example, 2016, 5/16, 05-2016.", "example": "5/2016" }, "city": { "maxLength": 255, "type": "string", "description": "The city of employment.", "example": "Bloomington" }, "state": { "maxLength": 255, "type": "string", "description": "The state/province or region of employment in open-format text.", "example": "MN" }, "country": { "maxLength": 255, "type": "string", "description": "The country of employment in open-format text.", "example": "US" }, "duties": { "type": "string", "description": "The duties the talent performed during employment.", "example": "Warehouse packing, loading and unloading." }, "reason_For_Leaving": { "type": "string", "description": "The reason for leaving.", "example": "Workforce reduction." }, "notes": { "type": "string", "description": "Additional notes on the talent's work history.", "example": "Would rehire." } }, "additionalProperties": false }, "front_office__TimeSheetDto": { "required": [ "dailyTime", "placementId", "status", "weekWorked" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the timesheet.", "format": "int32" }, "placementId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The identifier for the placement. It allows the timesheet to be correlated with the talent to whom the time belongs.", "format": "int32" }, "weekWorked": { "minLength": 1, "type": "string", "description": "The week ending date.\nThis is just a date stamp, no time should be included.", "format": "date-time" }, "dailyTime": { "type": "array", "description": "A list of time entries and their details.", "items": { "$ref": "#/components/schemas/front_office__TimeEntryDto" } }, "status": { "minLength": 1, "pattern": "^(Saved|Submitted|Approved)$", "type": "string", "description": "The status of the timesheet. Accepted Values are: Saved, Submitted and Approved." }, "timeSheetNote": { "description": "The note for the timesheet.", "oneOf": [ { "$ref": "#/components/schemas/front_office__TimeSheetNoteDto" } ] } }, "additionalProperties": false }, "front_office__TimeSheetNoteDto": { "required": [ "date", "note", "userId" ], "type": "object", "properties": { "date": { "minLength": 1, "type": "string", "description": "The Date for the TimeSheet note.\nThis is just a date stamp, no time should be included.", "format": "date-time" }, "userId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The Author for the TimeSheet note.", "format": "int32" }, "note": { "minLength": 1, "type": "string", "description": "The note for the TimeSheet." } }, "additionalProperties": false }, "front_office__AdditionalTimeEntryDto": { "required": [ "additionalTransactionTypeId" ], "type": "object", "properties": { "additionalTransactionTypeId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "Additional pay code except Reg, OT and DT.", "format": "int32" }, "punchIn": { "type": "string", "description": "The start time of the day." }, "punchOut": { "type": "string", "description": "The end time of the day." }, "unit": { "type": "number", "description": "The number of pay and/or bill units for the time entry. Usually units are hours. Optional when TimeIn and TimeOut is passed.", "format": "decimal" }, "payRate": { "type": "number", "description": "Pay Rate for the additional pay code. Used if placement is missing setup for additional transaction type.", "format": "decimal" }, "billRate": { "type": "number", "description": "Bill Rate for the additional pay code. Used if placement is missing setup for additional transaction type.", "format": "decimal" } }, "additionalProperties": false }, "front_office__TimeEntryDto": { "required": [ "dayWorked" ], "type": "object", "properties": { "dayWorked": { "minLength": 1, "type": "string", "description": "The date for the time entry.\nThis should be just a date stamp. No time should be included.", "format": "date-time" }, "timeIn": { "type": "string", "description": "The start time of the day." }, "timeOut": { "type": "string", "description": "The end time of the day." }, "breakOut": { "type": "string", "description": "The break start time." }, "breakIn": { "type": "string", "description": "The break end time." }, "breakUnit": { "type": "number", "description": "The break unit.", "format": "decimal" }, "additionalTimeEntry": { "type": "array", "description": "List of additional time entry.", "items": { "$ref": "#/components/schemas/front_office__AdditionalTimeEntryDto" } }, "dayWorkedCalulated": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "front_office__ApiWebApplicants": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32" }, "source": { "type": "string", "description": "The name of the source of the web application." }, "applyDate": { "type": "string", "description": "The date when the talent applied for a job on the web.", "format": "date-time" }, "webApplicantId": { "type": "integer", "description": "The identifier for the talent that applied for a job position on the web.", "format": "int32" }, "declineDate": { "type": "string", "description": "The date on which the talent was declined.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "front_office__NewWebApplicant": { "required": [ "applicationSource", "jobId", "talentId" ], "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32" }, "applicationSource": { "maxLength": 1000, "minLength": 1, "type": "string", "description": "The name of the source of the web application." } }, "additionalProperties": false }, "back_office__TimeEntryTransactionItem": { "required": [ "payRate", "payUnit", "transactionTypeId" ], "type": "object", "properties": { "transactionTypeId": { "type": "integer", "description": "The identifier for the transaction type.", "format": "int32" }, "payUnit": { "type": "number", "description": "The number of pay units for the time entry.", "format": "decimal" }, "payRate": { "type": "number", "description": "The rate of pay applied to the transaction.", "format": "decimal" } } }, "front_office__UserTypes": { "type": "string", "enum": [ "Unknown", "Talent", "Manager", "Hcm", "All" ] }, "front_office__EntityTypeUserDto": { "type": "object", "properties": { "userType": { "description": "The user type of specified user.", "oneOf": [ { "$ref": "#/components/schemas/front_office__UserTypes" } ] }, "userId": { "type": "integer", "description": "The identifier for the user.", "format": "int32" }, "entityId": { "type": "integer", "description": "The entity identifier for the user.", "format": "int32" } }, "additionalProperties": false }, "front_office__TalentCustomFields": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Talent Custom Field Tag.", "format": "int32", "example": 269492 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 183948 }, "customField1Name": { "maxLength": 100, "type": "string", "description": "The name of the first Custom Tag.", "example": "Future Goals" }, "customField1Type": { "type": "string", "description": "The type of the first Custom Tag. Valid types are 'Text', 'Number' and 'Date'.", "example": "Text" }, "customField1NumberValue": { "type": "integer", "description": "The number value returned if the first Custom Tag is a number type.", "format": "int32" }, "customField1DateValue": { "type": "string", "description": "The Date value returned if the first Custom Tag is a date type. The field follows the YYYY-MM-DD format, for example, 2024-12-01.", "format": "date" }, "customField1TextValue": { "type": "string", "description": "The text value returned if the first Custom Tag is a text type.", "example": "Manager" }, "customField2Name": { "maxLength": 100, "type": "string", "description": "The name of the second Custom Tag.", "example": "Total years in industry." }, "customField2Type": { "type": "string", "description": "The type of the second Custom Tag. Valid types are 'Text', 'Number' and 'Date'.", "example": "Number" }, "customField2NumberValue": { "type": "integer", "description": "The number value returned if the second Custom Tag is a number type.", "format": "int32", "example": 7 }, "customField2DateValue": { "type": "string", "description": "The Date value returned if the second Custom Tag is a date type. The field follows the YYYY-MM-DD format, for example, 2024-12-01.", "format": "date" }, "customField2TextValue": { "type": "string", "description": "The text value returned if the second Custom Tag is a text type." }, "customField3Name": { "maxLength": 100, "type": "string", "description": "The name of the third Custom Tag.", "example": "Date of final approval." }, "customField3Type": { "type": "string", "description": "The type of the third Custom Tag. Valid types are 'Text', 'Number' and 'Date'." }, "customField3NumberValue": { "type": "integer", "description": "The number value returned if the third Custom Tag is a number type.", "format": "int32" }, "customField3DateValue": { "type": "string", "description": "The Date value returned if the third Custom Tag is a date type. The field follows the YYYY-MM-DD format, for example, 2024-12-01.", "format": "date", "example": "2024-12-01" }, "customField3TextValue": { "type": "string", "description": "The text value returned if the third Custom Tag is a text type." } }, "additionalProperties": false }, "front_office__TalentAllTags": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "certifications": { "type": "array", "description": "A list of Certification Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentCertification" } }, "citizenshipList": { "type": "array", "description": "A list of Citizenship Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentCitizenship" } }, "companies": { "type": "array", "description": "A list of Company Experience Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentCompanyExperience" } }, "customFields": { "description": "A list of up to 3 Custom Fields for the talent and their details.", "oneOf": [ { "$ref": "#/components/schemas/front_office__TalentCustomFields" } ] }, "industries": { "type": "array", "description": "A list of Industry Experience Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentIndustryExperience" } }, "quickSearchTitles": { "type": "array", "description": "A list of Quick Search Title Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentQuickSearchTitle" } }, "resumeSkills": { "type": "array", "description": "A list of Resume Skill Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentResumeSkill" } }, "skills": { "type": "array", "description": "A list of Skill Set Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentSkill" } }, "sources": { "type": "array", "description": "A list of Source Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentSource" } }, "tags": { "type": "array", "description": "A list of Talent Tags and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentTag" } } }, "additionalProperties": false }, "front_office__ArrayOfCompanyRestriction": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__CompanyRestriction" } }, "front_office__CompanyContacts": { "type": "object", "properties": { "companyId": { "type": "integer", "description": "The identifier for the Company.", "format": "int32", "example": 12345 }, "contactIds": { "type": "array", "description": "List of identifiers for Contacts.", "example": [ 67890, 54321 ], "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "front_office__ArrayOfCompanyContacts": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__CompanyContacts" } }, "front_office__ArrayOfCustomJobDetailsDefinition": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__CustomJobDetailsDefinition" } }, "front_office__CustomJobDetailsDefinition": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the custom job detail definition.", "format": "int32", "example": 1842 }, "detailName": { "maxLength": 255, "type": "string", "description": "The name of the custom job detail definition.", "example": "Dress Code" }, "detailType": { "type": "string", "description": "The type of custom job detail. The possible values are 'checkbox', 'minmax', 'numeric', 'text', 'time'.", "example": "text" } }, "additionalProperties": false }, "front_office__DepartmentDefaultContactsDictionary": { "type": "object", "properties": { "branch_default_contacts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "nonexistent_branches": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "front_office__DepartmentDefaultTimesheetApproversDictionary": { "type": "object", "properties": { "branch_default_timesheet_approvers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "nonexistent_branches": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "front_office__EEODefinitions": { "type": "object", "properties": { "genders": { "type": "array", "description": "A list of values for the Gender dropdown.", "example": [ "Male", "Female", "Non-Binary", "I do not wish to answer" ], "items": { "type": "string" } }, "races": { "type": "array", "description": "A list of values for the Race dropdown.", "example": [ "American Indian or Alaska Native", "Asian (Not Hispanic or Latino)", "Black or African American (Not Hispanic or Latino)", "Hispanic or Latino", "Native Hawaiian or Other Pacific Islander", "Two or More Races (Not Hispanic or Latino)", "White (Not Hispanic or Latino", "I do not wish to answer" ], "items": { "type": "string" } }, "disabilities": { "type": "array", "description": "A list of values for the Disability dropdown.", "example": [ "Individual with Disabilities", "Individual without Disabilities", "I do not wish to answer" ], "items": { "type": "string" } }, "veteranStatuses": { "type": "array", "description": "A list of values for the Veteran Status dropdown.", "example": [ "Armed Forces Services Medal Veteran", "Disabled Veteran", "Non Veteran", "Other Protected Veteran", "Recently Separated Veteran", "Active Wartime or Campaign Badge Veteran", "I do not wish to answer" ], "items": { "type": "string" } } }, "additionalProperties": false }, "front_office__ArrayOfEverifyDomainModel": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__EverifyDomainModel" } }, "front_office__ArrayOfJobStatusData": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__JobStatusData" } }, "front_office__JobStatusData": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the job status.", "format": "int32", "example": 1234 }, "item": { "maxLength": 255, "type": "string", "description": "The job status name.", "example": "Active" }, "type": { "type": "string", "description": "The type of job status. Values are \"open\" or \"closed\". Open and closed job statuses are grouped together in BOLD.", "example": "open" }, "statusOrder": { "type": "integer", "description": "Numerical order value for the job status in the list of statuses in BOLD.", "format": "int32", "example": 1 } }, "additionalProperties": false }, "front_office__ArrayOfJobType": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__JobType" } }, "front_office__JobType": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the job type.", "format": "int32", "example": 123 }, "jobTypeName": { "maxLength": 255, "type": "string", "description": "The name of the job type.", "example": "Temporary" }, "jobTypeDetail": { "maxLength": 50, "type": "string", "description": "Job type detail.", "example": "Contract" } }, "additionalProperties": false }, "front_office__NewJobRequiredFields": { "type": "object", "properties": { "clientAddress": { "type": "boolean", "description": "A flag indicating worksite address1 may be required when creating a new job.", "example": true }, "clientCity": { "type": "boolean", "description": "A flag indicating worksite city may be required when creating a new job.", "example": true }, "clientState": { "type": "boolean", "description": "A flag indicating worksite state may be required when creating a new job.", "example": true }, "clientZip": { "type": "boolean", "description": "A flag indicating worksite zip may be required when creating a new job.", "example": true }, "clientEmail": { "type": "boolean", "description": "A flag indicating contact email may be required when creating a new job.", "example": true }, "clientPhone": { "type": "boolean", "description": "A flag indicating contact phone1 may be required when creating a new job.", "example": true }, "endDate": { "type": "boolean", "description": "A flag indicating endDate may be required when creating a new job.", "example": true }, "estimatedHours": { "type": "boolean", "description": "A flag indicating estimatedHours may be required when creating a new job.", "example": true }, "jobCity": { "type": "boolean", "description": "A flag indicating contact city may be required when creating a new job.", "example": true }, "jobCountry": { "type": "boolean", "description": "A flag indicating contact country may be required when creating a new job.", "example": true }, "jobState": { "type": "boolean", "description": "A flag indicating contact state may be required when creating a new job.", "example": true }, "placementFeeAmount": { "type": "boolean", "description": "A flag indicating placementFee may be required when creating a new job.", "example": true }, "placementFeePercent": { "type": "boolean", "description": "A flag indicating placementPercentage may be required when creating a new job.", "example": true }, "positionCategorySkill": { "type": "boolean", "description": "A flag indicating positionCategoryId may be required when creating a new job.", "example": true }, "targetBillRate": { "type": "boolean", "description": "A flag indicating targetBillRate may be required when creating a new job.", "example": true }, "targetPayRate": { "type": "boolean", "description": "A flag indicating targetPayRate may be required when creating a new job.", "example": true }, "workersCompCode": { "type": "boolean", "description": "A flag indicating workerCompCodeId may be required when creating a new job.", "example": true }, "customJobDetails": { "type": "array", "description": "A list of required Custom Job Details.", "items": { "$ref": "#/components/schemas/front_office__CustomJobDetail" } } }, "additionalProperties": false }, "front_office__OTRules": { "type": "object", "properties": { "ruleId": { "type": "integer", "description": "The identifier for the overtime rule.", "format": "int32", "example": 12345 }, "ruleName": { "maxLength": 200, "type": "string", "description": "The name of the overtime rule.", "example": "Standard Overtime Rule" } }, "additionalProperties": false }, "front_office__ArrayOfOTRules": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__OTRules" } }, "front_office__Skill": { "type": "object", "properties": { "positionId": { "type": "integer", "description": "The identifier for the position category.", "format": "int32", "example": 381 }, "position": { "maxLength": 100, "type": "string", "description": "The name of the position category.", "example": "Clerical" }, "descriptionId": { "type": "integer", "description": "The identifier for the description.", "format": "int32", "example": 2998 }, "description": { "maxLength": 255, "type": "string", "description": "The description for the skill.", "example": "Data Entry" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 }, "talentFacing": { "type": "boolean", "description": "An indication of whether a skill is visible and applicable to talent users.", "readOnly": true, "example": true } }, "additionalProperties": false }, "front_office__ArrayOfSkill": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__Skill" } }, "front_office__ArrayOfPlacement": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__Placement" } }, "front_office__SkillCategory": { "type": "object", "properties": { "positionId": { "type": "integer", "description": "The identifier for the position option.", "format": "int32", "example": 274 }, "position": { "maxLength": 100, "type": "string", "description": "The name of the position option.", "example": "Clerical" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "front_office__ArrayOfSkillCategory": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__SkillCategory" } }, "front_office__ArrayOfTalentEducationHistory": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentEducationHistory" } }, "front_office__ArrayOfTalentStage": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentStage" } }, "front_office__ArrayOfApiWebApplicants": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__ApiWebApplicants" } }, "bo_prod__AccrualDateTypeOption": { "type": "string", "description": "An option used to define the date type for talent accrual plans.", "example": "CalendarDate", "enum": [ "CalendarDate", "AnniversaryDate", "Unknown" ] }, "bo_prod__AccrualRateTypeOption": { "type": "string", "description": "An option used to define the rate type for talent accrual plans.", "example": "PerHour", "enum": [ "PerHour", "PerPayPeriod", "Unknown" ] }, "back_office__ArrayOfMappedData": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__MappedData" } }, "back_office__MappedData": { "type": "object", "properties": { "mappingTypeName": { "type": "string" }, "sourceSystemValue": { "type": "string" }, "mappedValueID": { "type": "string" }, "mappedValue": { "type": "string" } }, "additionalProperties": false }, "back_office__ArrayOfConfigChoice": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__V2ConfigChoice" } }, "front_office__ArrayOfActivityType": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__ActivityType" } }, "front_office__BankAccount": { "required": [ "accountCountry", "accountName", "accountNumber", "accountType", "amountType", "fundingType", "institutionNumber", "proxyNumber", "routingNumber" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the bank account.", "format": "int32", "example": 278 }, "accountType": { "maxLength": 50, "type": "string", "description": "The account type.", "example": "Checking" }, "routingNumber": { "type": "string", "description": "The routing number (9 digits).", "example": "291070001" }, "accountNumber": { "maxLength": 255, "type": "string", "description": "The account number.", "example": "234544111" }, "institutionNumber": { "maxLength": 50, "type": "string", "description": "The identifier for a financial institution, business, or company.", "example": "2847" }, "accountName": { "maxLength": 255, "type": "string", "description": "The name of the account.", "example": "Checking Account" }, "accountCountry": { "type": "string", "description": "The country in which the bank operates. A 2-letter ISO 3166-1 alpha-2 code represents the country (e.g., \"US\", not \"USA\"). For details, see the General Guidelines.", "example": "US" }, "amountType": { "type": "string", "description": "The amount type used to calculate the deposit. Options include `Remaining Amount`, `Percent`, and `Fixed Amount`. If `Remaining Amount` is selected, the amount must be set to `0`, and only one of the talent's accounts can use this type.", "example": "Percent" }, "amount": { "type": "number", "description": "The dollar amount or percentage that should be distributed to this account. The total percentage for all of the talent's accounts cannot exceed 100%.", "format": "decimal", "example": 75 }, "accountOrder": { "type": "integer", "description": "The order in which deposits are made to the talent’s accounts. Should be a unique integer within the list of a talent’s bank accounts.", "format": "int32", "example": 1 }, "isActivated": { "type": "boolean", "description": "An indication of whether the Pay Card has been activated. If the account type is not Pay Card, this value is always false.", "example": true }, "proxyNumber": { "maxLength": 255, "type": "string", "description": "A short identifier that links a payment account to a unique reference, such as a phone number or email address, enabling transactions without exposing bank account details.", "example": "125362" }, "fundingType": { "maxLength": 50, "type": "string", "description": "The funding type (available for the rapid! PayCard account type).", "example": "Instant Payment" } }, "additionalProperties": false }, "front_office__ArrayOfBankAccount": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BankAccount" } }, "front_office__TalentAppliedJobs": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "totalJobs": { "type": "integer", "description": "The number of posted jobs the talent has applied for.", "format": "int32" }, "jobs": { "type": "array", "description": "The list of posted jobs the talent has applied for.", "items": { "$ref": "#/components/schemas/front_office__ApplicantAppliedJob" } } }, "additionalProperties": false }, "front_office__ApplicantAppliedJob": { "type": "object", "properties": { "applicationId": { "type": "integer", "description": "The identifier for the web application.", "format": "int32" }, "applicationDate": { "type": "string", "description": "The date the talent applied for the job.", "format": "date-time" }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32" }, "workSiteAddress": { "description": "The worksite address for the job.", "oneOf": [ { "$ref": "#/components/schemas/front_office__ApplicationWorkSiteAddress" } ] }, "hourlyMinimum": { "type": "integer", "description": "The minimum hourly pay rate for the job.", "format": "int32" }, "hourlyMaximum": { "type": "integer", "description": "The maximum hourly pay rate for the job.", "format": "int32" }, "salaryMinimum": { "type": "integer", "description": "The minimum salary for the job.", "format": "int32" }, "salaryMaximum": { "type": "integer", "description": "The maximum salary for the job.", "format": "int32" }, "postedDate": { "type": "string", "description": "The date the job was posted.", "format": "date-time" }, "startDate": { "type": "string", "description": "The estimated start date.", "format": "date-time" }, "endDate": { "type": "string", "description": "The estimated end date.", "format": "date-time" }, "customJobDetails": { "type": "array", "description": "A list of custom job details.", "items": { "$ref": "#/components/schemas/front_office__CustomJobDetail" } }, "title": { "type": "string", "description": "The job title on the job board." }, "description": { "type": "string", "description": "The job description on the job board." } }, "additionalProperties": false }, "front_office__ApplicationWorkSiteAddress": { "type": "object", "properties": { "address1": { "type": "string", "description": "Street address, line 1." }, "address2": { "type": "string", "description": "Street address, line 2." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "Province, state, or region." }, "postalCode": { "type": "string", "description": "ZIP/postal code." }, "country": { "type": "string", "description": "Country." } }, "additionalProperties": false }, "front_office__ApplicantProfileImageResponseDto": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "profileImageName": { "type": "string", "description": "The name of the profile image." }, "profileImage": { "type": "string", "description": "The profile image in base64 string." } }, "additionalProperties": false }, "front_office__TimeSheet": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the timesheet.", "format": "int32" }, "placementId": { "type": "integer", "description": "The identifier for the placement. It allows the timesheet to be correlated with the talent to whom the time belongs.", "format": "int32" }, "placementExtensionID": { "type": "integer", "description": "The identifier for the placement extension.", "format": "int32" }, "companyId": { "type": "integer", "description": "The identifier for the company.", "format": "int32" }, "companyName": { "maxLength": 255, "type": "string", "description": "The name of the company." }, "weekWorked": { "type": "string", "description": "The week ending date.\nThis is just a date stamp, no time should be included.", "format": "date-time" }, "savedTime": { "type": "string", "description": "The date and time when the first time entry was saved for the timesheet.", "format": "date-time" }, "savedBy": { "type": "string", "description": "The name of the user who saved the first time entry for the timesheet." }, "submittedTime": { "type": "string", "description": "The date and time when the timesheet was submitted.", "format": "date-time" }, "submittedBy": { "type": "string", "description": "The name of the user who submitted the timesheet." }, "approvedTime": { "type": "string", "description": "The date and time when the timesheet was submitted.", "format": "date-time" }, "approvedBy": { "type": "string", "description": "The name of the user who approved the timesheet." }, "dailyTime": { "type": "array", "description": "A list of time entries and their details.", "items": { "type": "object", "description": "front_office__TimeEntry (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } }, "additionalProperties": false }, "front_office__TimeEntry": { "type": "object", "properties": { "dayWorked": { "type": "string", "description": "The date for the time entry.\nThis should be just a date stamp. No time should be included.", "format": "date-time" }, "payCode": { "type": "string", "description": "The pay code. One of REG (regular time), OT (overtime), DT (double-time)." }, "payUnit": { "type": "number", "description": "The number of pay units for the time entry. Usually units are hours.", "format": "decimal" }, "billUnit": { "type": "number", "description": "The number of bill units for the time entry. Usually units are hours.", "format": "decimal" }, "payRate": { "type": "number", "description": "The corresponding placement pay rate for the time entry. Could be regular, overtime or double-time pay rate, depending on the paycode.", "format": "decimal" }, "billRate": { "type": "number", "description": "The corresponding placement bill rate for the time entry. Could be regular, overtime or double-time bill rate, depending on the paycode.", "format": "decimal" }, "timeIn": { "type": "string", "description": "The start time of the day." }, "timeOut": { "type": "string", "description": "The end time of the day." }, "breakIn": { "type": "string", "description": "The break start time." }, "breakOut": { "type": "string", "description": "The break end time." }, "timeInDateTime": { "type": "string", "description": "The start time in full date-time format with time in 24-hour clock time.", "format": "date-time" }, "timeOutDateTime": { "type": "string", "description": "The end time in full date-time format with time in 24-hour clock time.", "format": "date-time" }, "breakStartDateTime": { "type": "string", "description": "The break start time in full date-time format with time in 24-hour clock time.", "format": "date-time" }, "breakEndDateTime": { "type": "string", "description": "The break end time in full date-time format with time in 24-hour clock time.", "format": "date-time" }, "leaveTypeId": { "type": "integer", "description": "The identifier for the leave type.", "format": "int32" }, "dayPayId": { "type": "integer", "description": "The identifier for the day pay timesheets.", "format": "int32" } }, "additionalProperties": false }, "front_office__ApproverTerms": { "required": [ "last_modified_date", "terms_id", "terms_text" ], "type": "object", "properties": { "terms_id": { "type": "integer", "description": "The database identifier of the account's configured Approver Terms record. `0` when _Approver Terms_ are not configured for the account.", "format": "int32", "example": 202 }, "terms_text": { "type": "string", "description": "The attestation text presented to a supervisor when approving a timesheet. `Null` when _Approver Terms_ are not configured for the account.", "nullable": true, "example": "I approve these hours as submitted." }, "last_modified_date": { "type": "string", "description": "The date and time when the account's Approver Terms were last updated. `Null` when _Approver Terms_ are not configured for the account. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The account's configured timesheet Approver Terms. All properties are always present." }, "front_office__TalentStatus": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent status.", "format": "int32", "example": 321 }, "status": { "maxLength": 255, "type": "string", "description": "The talent status.", "example": "Active" }, "statusType": { "maxLength": 50, "type": "string", "description": "The talent status type. Valid values are General, Pending, Do Not Assign.", "example": "General" } }, "additionalProperties": false }, "front_office__ArrayOfTalentStatus": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentStatus" } }, "front_office__ArrayOfBackgroundCheck": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BackgroundCheck" } }, "front_office__BackgroundCheck": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 17482 }, "orderDate": { "type": "string", "description": "The date and time when the background check order was placed. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "packageId": { "maxLength": 50, "type": "string", "description": "The identifier for the background check package.", "example": "275d01e5-420c-46a0-8083-70926009df5b" }, "packageName": { "maxLength": 300, "type": "string", "description": "The name of the background check package.", "example": "Basic Package" }, "partnerOrderStatus": { "maxLength": 100, "type": "string", "description": "The status name for the partner order.", "example": "Completed" }, "score": { "maxLength": 100, "type": "string", "description": "The partner score status for the background check.", "example": "Passed" }, "orderStatus": { "type": "string", "description": "The status of the background check order.", "example": "1" }, "adverseAction": { "maxLength": 50, "type": "string", "description": "The pre-adverse action status for the background check.", "example": "Initiated" }, "officeId": { "type": "integer", "description": "The identifier for the office branch.", "format": "int32", "example": 4785 }, "completedDate": { "type": "string", "description": "The date and time when the background check order was completed. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "reviewStatus": { "type": "string", "description": "The review status of the order.", "example": "1" }, "reviewedDate": { "type": "string", "description": "The review date and time of the order. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "expiringDate": { "type": "string", "description": "The date and time when the background check is set to expire. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "deletedDate": { "type": "string", "description": "The date and time when the background check order was deleted. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "providerName": { "maxLength": 50, "type": "string", "description": "The name of the background check provider.", "example": "Asurint" }, "backgroundCheckId": { "type": "integer", "description": "The unique identifier for the background check record.", "format": "int32", "example": 18345 } }, "additionalProperties": false }, "bo_prod__BillingPeriodOptionArray": { "type": "array", "example": [ { "billingPeriod": "Weekly", "validBillingCycles": [ "1" ] }, { "billingPeriod": "BiWeekly", "validBillingCycles": [ "1", "2" ] }, { "billingPeriod": "Monthly", "validBillingCycles": [ "1", "2", "3", "4", "LastWeek" ] } ], "items": { "$ref": "#/components/schemas/bo_prod__BillingPeriodOption" } }, "bo_prod__BillingPeriodOption": { "type": "object", "properties": { "billingPeriod": { "$ref": "#/components/schemas/bo_prod__BillPeriod" }, "validBillingCycles": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__BillPeriodCycle" } } } }, "bo_prod__CustomSetupOptionArray": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__CustomSetupOption" } }, "bo_prod__CustomSetupOption": { "type": "object", "properties": { "optionId": { "type": "integer", "description": "The unique identifier for the setup option.", "format": "int32", "nullable": true, "example": 1 }, "optionName": { "type": "string", "description": "The display name of the setup option.", "example": "Employee" }, "categoryId": { "type": "integer", "description": "The unique identifier for the category associated with the option.", "format": "int32", "nullable": true, "example": 21 }, "categoryName": { "type": "string", "description": "The display name of the option category.", "example": "Invoice Grouping" }, "branchGuid": { "type": "string", "description": "The unique identifier for the Branch associated with the option.", "format": "uuid", "example": "75997192-a570-4087-baab-e08d84448956" }, "isVisible": { "type": "boolean", "description": "An indication of whether this custom setup option is visible to the current branch.", "example": true }, "customSetupOptionProperties": { "type": "array", "items": { "type": "object", "description": "bo_prod__CustomSetupOptionProperty (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } } }, "bo_prod__CustomSetupOptionProperty": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "The name of the option property.", "example": "SortOrder" }, "propertyDescription": { "type": "string", "description": "The description of the option property.", "example": "The order in which the option is applied." }, "defaultValue": { "type": "string", "description": "The default value of the property.", "example": "1" }, "propertyValue": { "type": "string", "description": "The current value of the option property.", "example": "1" } } }, "bo_prod__InvoiceStyleArray": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__InvoiceStyle" } }, "bo_prod__InvoiceStyle": { "type": "object", "properties": { "invoiceStyleId": { "type": "string", "description": "The unique identifier for the invoice style.", "format": "uuid", "example": "3f2504e0-4f89-41d3-9a0c-0305e82c3301" }, "invoiceStyleTitle": { "type": "string", "description": "The display name of the invoice style.", "example": "Standard" }, "invoiceStyleDescription": { "type": "string", "description": "The description of the invoice style.", "example": "Standard invoice layout with itemized hours and amounts." } } }, "front_office__Employer": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the employer." }, "address": { "description": "The address of the employer.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "fein": { "type": "string", "description": "The FEIN of the employer." } }, "additionalProperties": false }, "front_office__Branch": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the employer branch.", "format": "int32" }, "name": { "type": "string", "description": "The name of the employer branch." }, "employer": { "description": "Information about the employer.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Employer" } ] }, "branchAddress": { "description": "The address of the employer branch.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "phoneNumber": { "type": "string", "description": "Branch phone number." }, "email": { "type": "string", "description": "Branch email address." } }, "additionalProperties": false }, "front_office__ArrayOfBranch": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__Branch" } }, "back_office__ArrayOfBranch": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__Branch" } }, "back_office__PhoneNumber": { "maxLength": 14, "minLength": 14, "pattern": "^\\(\\d{3}\\)-\\d{3}-\\d{4}$", "type": "string", "description": "Phone number.", "example": "(969)-506-4483" }, "back_office__Address": { "required": [ "city", "country", "postalCode", "state", "street1" ], "type": "object", "properties": { "addressGuid": { "type": "string", "description": "Unique identifier for the address, formatted as a UUID.", "format": "uuid", "example": "cb63d8fc-6d06-f011-87a7-a0595061251e" }, "street1": { "maxLength": 50, "type": "string", "description": "Street address, line 1.", "example": "123 Main St." }, "street2": { "maxLength": 50, "type": "string", "description": "Street address, line 2.", "example": "Suite 250" }, "city": { "maxLength": 50, "type": "string", "description": "City.", "example": "Minneapolis" }, "state": { "maxLength": 2, "minLength": 2, "type": "string", "description": "Province, state, or region.", "example": "MN" }, "postalCode": { "pattern": "^\\d{5}(-\\d{4})?$", "type": "string", "description": "ZIP/postal code.", "example": "55435" }, "country": { "$ref": "#/components/schemas/back_office__CountryCode" } } }, "back_office__CountryCode": { "maxLength": 2, "minLength": 2, "type": "string", "description": "A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., \"US\", not \"USA\"). For details, see the General Guidelines.", "example": "US" }, "back_office__Branch": { "type": "object", "properties": { "branchGuid": { "type": "string", "description": "The unique identifier for the Branch, formatted as a UUID.", "format": "uuid", "x-disabled-for-amazon-gateway": { "example": "184fd8fc-6d06-f011-87a7-a0595061251e" }, "example": null }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Short Name of the Branch.", "x-disabled-for-amazon-gateway": { "example": "Eagan" }, "example": null }, "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Full Name of the Branch.", "x-disabled-for-amazon-gateway": { "example": "Eagan" }, "example": null }, "active": { "type": "boolean", "description": "An indication of whether the branch is active.", "x-disabled-for-amazon-gateway": { "example": true }, "example": null }, "supplierGuid": { "type": "string", "description": "The unique indentifier for the Staffing Supplier, formatted as a UUID.", "format": "uuid", "x-disabled-for-amazon-gateway": { "example": "cc63d8fc-6d06-f011-87a7-a0595061251e" }, "example": null }, "phoneNumber": { "$ref": "#/components/schemas/back_office__PhoneNumber" }, "address": { "$ref": "#/components/schemas/back_office__Address" } } }, "front_office__Company": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 12345 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the company.", "example": "Acme Corporation" }, "mainAddress": { "description": "The main address of the company.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "billingAddress": { "description": "The billing address of the company.", "oneOf": [ { "$ref": "#/components/schemas/front_office__Address" } ] }, "frontOfficeId": { "type": "integer", "description": "The identifier for the company's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.", "format": "int32", "example": 12353 }, "link": { "type": "string", "description": "The BOLD URL of the company.", "example": "https://abc.myavionte.com/app/#/company/12345" }, "isArchived": { "type": "boolean", "description": "An indication of whether the company record is archived or not.", "example": false }, "representativeUsers": { "type": "array", "description": "The IDs of the representatives who are working with the company.", "example": [ 18394, 18402 ], "items": { "type": "integer", "format": "int32" } }, "statusId": { "type": "integer", "description": "The identifier for the company status.", "format": "int32", "example": 184 }, "status": { "maxLength": 255, "type": "string", "description": "The company status.", "example": "Active" }, "statusType": { "maxLength": 50, "type": "string", "description": "The company status type.", "example": "General" }, "industry": { "maxLength": 100, "type": "string", "description": "The company industry.", "example": "Information Technology" }, "createdDate": { "type": "string", "description": "The date the company profile was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "lastUpdatedDate": { "type": "string", "description": "The date of the most recent update to the company profile. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "latestActivityDate": { "type": "string", "description": "The date of the company's latest activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "latestActivityName": { "maxLength": 255, "type": "string", "description": "The name of the company's latest activity.", "example": "Meeting" }, "openJobs": { "type": "integer", "description": "The number of open jobs in the company.", "format": "int32", "example": 15 }, "phoneNumber": { "maxLength": 255, "type": "string", "description": "The phone number of the company.", "example": "800-555-0199" }, "fax": { "maxLength": 255, "type": "string", "description": "The fax number of the company.", "example": "800-555-0198" }, "webSite": { "maxLength": 255, "type": "string", "description": "The website of the company.", "example": "https://www.acmecorp.com" }, "origin": { "maxLength": 50, "type": "string", "description": "The partner or vendor that originated the request.", "example": "PartnerX" }, "originRecordId": { "maxLength": 255, "type": "string", "description": "The identifier for the company that can be used to link the record within the originating system.", "example": "12345-abcde" }, "weekEndDay": { "maxLength": 255, "type": "string", "description": "The Week End Day of the company. Valid values are 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', and 'Sunday'.", "example": "Friday" }, "payPeriod": { "maxLength": 255, "type": "string", "description": "The Pay Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.", "example": "BiWeekly" }, "payCycle": { "maxLength": 255, "type": "string", "description": "The Pay Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.", "example": "Last Week" }, "billingPeriod": { "maxLength": 255, "type": "string", "description": "The Bill Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.", "example": "Monthly" }, "billingCycle": { "maxLength": 255, "type": "string", "description": "The Bill Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.", "example": "2" }, "isParent": { "type": "boolean", "description": "Indicates whether the company is a parent company.", "example": true }, "parentCompanyId": { "type": "integer", "description": "The identifier for the parent company if this company is a child.", "format": "int32", "example": 13839 } }, "additionalProperties": false }, "front_office__ArrayOfCompanyCategoryTag": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__CompanyCategoryTag" } }, "front_office__ArrayOfArrayOfCompanyCategoryTag": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__ArrayOfCompanyCategoryTag" } }, "back_office__CompanyTypeExtraValue": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "idType": { "$ref": "#/components/schemas/back_office__AvionteOfficeTypeEnum" }, "extraValues": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__Extra" } } }, "additionalProperties": false }, "back_office__CompanyExtraRequest": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the company.", "format": "int32" }, "idType": { "type": "string", "description": "The company identifier type. BOLD or BO." }, "useRoot": { "type": "boolean", "description": "The indicator to use company or its root company." } }, "additionalProperties": false }, "back_office__AvionteOfficeTypeEnum": { "type": "string", "enum": [ "BOLD", "BO" ] }, "back_office__Extra": { "type": "object", "properties": { "extraLabelID": { "type": "integer", "format": "int32" }, "extraLabel": { "type": "string" }, "extraValue": { "type": "string" } }, "additionalProperties": false }, "back_office__CompanyExtraValue": { "type": "object", "properties": { "backOfficeCompanyID": { "type": "integer", "description": "The identifier for the company in the Back Office.", "format": "int32" }, "boldCompanyID": { "type": "integer", "description": "The identifier for the company in BOLD.", "format": "int32" }, "extraValues": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__Extra" } } }, "additionalProperties": false }, "back_office__ArrayOfCompanyExtraValue": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__CompanyExtraValue" } }, "bo_prod__backofficeIdentifierUuid": { "type": "string", "description": "The unique identifier for the Back Office entity, formatted as a UUID.", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "bo_prod__HoursHistoryDetail": { "type": "object", "properties": { "hoursDetails": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__HoursDetail" } } } }, "bo_prod__HoursDetail": { "type": "object", "properties": { "transactionGuid": { "type": "string", "description": "The unique identifier associated with the hours, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, "transactionEntryItemGuid": { "type": "string", "description": "The unique identifier associated with the hours detail row, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "373a7c95-8e75-468e-b5dd-1a7351ff76e0" }, "transactionType": { "type": "string", "description": "The transaction type name for the hours detail row.", "example": "Regular" }, "payUnit": { "type": "number", "description": "The number of pay units associated with the hours detail row.", "format": "double", "nullable": true, "example": 40 }, "billUnit": { "type": "number", "description": "The number of bill units associated with the hours detail row.", "format": "double", "nullable": true, "example": 40 }, "payRate": { "type": "number", "description": "The pay rate for the hours detail row.", "format": "double", "nullable": true, "example": 20 }, "billRate": { "type": "number", "description": "The bill rate for the hours detail row.", "format": "double", "nullable": true, "example": 30 }, "costRate": { "type": "number", "description": "The cost rate for the hours detail row.", "format": "double", "nullable": true, "example": 22 }, "itemPay": { "type": "number", "description": "The item pay for the hours detail row, calculated as the pay units multiplied by the pay rate.", "format": "double", "nullable": true, "example": 800 }, "itemBill": { "type": "number", "description": "The item bill for the hours detail row, calculated as the bill units multiplied by the bill rate.", "format": "double", "nullable": true, "example": 1200 }, "itemCost": { "type": "number", "description": "The item cost for the hours detail row.", "format": "double", "nullable": true, "example": 880 }, "itemText": { "type": "string", "description": "A free-text note field associated with the hours detail row.", "example": "Week ending 2026-05-09" } } }, "bo_prod__InvoicePage": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/bo_prod__PageData" }, { "type": "object", "properties": { "currentInvoiceSortField": { "$ref": "#/components/schemas/bo_prod__InvoiceSortFields" }, "validInvoiceSortFields": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__InvoiceSortFields" } }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__Invoice" } } }, "additionalProperties": false } ] }, "bo_prod__Invoice": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "The unique identifier for the Invoice, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, "invoiceNumber": { "type": "string", "description": "The current invoice number, unique per supplier.", "example": "INV-100234" }, "invoiceDate": { "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "The invoice date, formatted as YYYY-MM-DD, without a timestamp.", "format": "date", "nullable": true }, "billAmount": { "type": "number", "description": "The total bill amount of all transactions associated with the current invoice.", "format": "double", "nullable": true, "example": 123 }, "invoiceAmount": { "type": "number", "description": "The total bill amount of all transactions associated with the current invoice, including sales taxes and excluding discounts.", "format": "double", "nullable": true, "example": 123 }, "balanceAmount": { "type": "number", "description": "The total remaining balance for the invoice.", "format": "double", "nullable": true, "example": 123 }, "salesTaxAmount": { "type": "number", "description": "The total sales tax amount calculated for this invoice.", "format": "double", "nullable": true, "example": 123 }, "discountTaxAmount": { "type": "number", "description": "The total discount amount calculated for this invoice.", "format": "double", "nullable": true, "example": 123 }, "dueDate": { "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "The invoice due date, formatted as YYYY-MM-DD, without a timestamp.", "format": "date", "nullable": true }, "branchId": { "type": "string", "description": "The unique identifier for the Branch associated with this invoice, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, "paymentTermOptionId": { "type": "integer", "description": "The invoice payment term selected for this invoice.", "format": "int32", "nullable": true, "example": 1 }, "isPosted": { "type": "boolean", "description": "An indication of whether processing of this invoice has been finalized (true) or not (false).", "nullable": true, "example": true }, "billingBatchId": { "type": "string", "description": "The unique identifier for the Billing Batch that contains the current invoice, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, "invoiceToId": { "type": "string", "description": "The unique identifier for the Company associated with the current invoice, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, "invoiceStyleId": { "type": "string", "description": "The unique identifier for the Invoice Style associated with the current invoice, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, "invoiceTypeOptionId": { "type": "integer", "description": "The invoice type option identifier for the current invoice.", "format": "int32", "nullable": true, "example": 1 }, "totalFinanceChargeAmount": { "type": "number", "description": "The total finance charge amount for the current invoice.", "format": "double", "nullable": true, "example": 123 } } }, "bo_prod__SortMethod": { "type": "string", "description": "The valid options for determining how data in a paged response is sorted.", "example": "Ascending", "enum": [ "Ascending", "Descending" ] }, "bo_prod__InvoiceSortFields": { "type": "string", "description": "Valid options for invoice fields to sort by.", "example": "Invoice Number", "enum": [ "Invoice Number", "Due Date" ] }, "bo_prod__PageData": { "type": "object", "properties": { "totalResults": { "type": "integer", "description": "The total number of results.", "format": "int32", "nullable": true, "example": 42 }, "pageSize": { "type": "integer", "description": "The number of results included per page.", "format": "int32", "nullable": true, "example": 20 }, "currentPage": { "type": "integer", "description": "The current page number.", "format": "int32", "nullable": true, "example": 1 }, "totalPages": { "type": "integer", "description": "The total number of pages available.", "format": "int32", "nullable": true, "example": 3 }, "currentPageSize": { "type": "integer", "description": "The number of records in the current page.", "format": "int32", "nullable": true, "example": 20 }, "currentSortMethod": { "allOf": [ { "$ref": "#/components/schemas/bo_prod__SortMethod" } ] }, "validSortMethods": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/bo_prod__SortMethod" } } }, "additionalProperties": false }, "front_office__CompanyPo": { "type": "object", "properties": { "po_ID": { "type": "integer", "description": "The identifier for the purchase order.", "format": "int32", "example": 12345 }, "po_comp": { "type": "integer", "description": "The identifier for the company.", "format": "int32", "example": 12346 }, "po_num": { "maxLength": 50, "type": "string", "description": "The purchase order number.", "example": "PO-12345" }, "po_amount": { "type": "number", "description": "The net amount of the purchase order.", "format": "decimal", "example": 1000 }, "po_amountused": { "type": "number", "description": "The used amount of the purchase order.", "format": "decimal", "example": 200 }, "po_remaining": { "type": "number", "description": "The remaining amount of the purchase order.", "format": "decimal", "example": 800 }, "po_threshold": { "type": "number", "description": "The purchase order threshold amount.", "format": "decimal", "example": 900 }, "po_notify": { "type": "boolean", "description": "An indication of whether a notification email will be sent when the remaining amount reaches the threshold.", "example": true }, "notify_users": { "type": "string", "description": "The IDs of the users who will be sent notification emails.", "example": "12345,67890" }, "notify_sent": { "type": "boolean", "description": "An indication of whether a notification email has been sent to the specified users or not.", "example": false }, "notify_sent_date": { "type": "string", "description": "The date when the notification was sent. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "po_description": { "type": "string", "description": "The purchase order description.", "example": "Purchase order for office supplies" }, "is_active": { "type": "boolean", "description": "An indication of whether the purchase order is active or inactive.", "example": true }, "sendnotification": { "type": "boolean", "description": "An indication of whether a notification email has been sent to the specified users or not.", "example": false }, "comp_name": { "maxLength": 255, "type": "string", "description": "The name of the company associated with the purchase order.", "example": "Acme Corporation" } }, "additionalProperties": false }, "front_office__ArrayOfCompanyStatusDTO": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__CompanyStatusDTO" } }, "front_office__CompanyStatusDTO": { "type": "object", "properties": { "statusId": { "type": "integer", "description": "The identifier for the status.", "format": "int32", "example": 263 }, "statusName": { "maxLength": 255, "type": "string", "description": "The name for the status.", "example": "Active" }, "statusType": { "maxLength": 50, "type": "string", "description": "The name for the type of status.", "example": "General" }, "frontOfficeTenantId": { "type": "integer", "description": "The identifier for the tenant.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "front_office__CompanyTagDefinitions": { "type": "object", "properties": { "companyCategories": { "type": "array", "description": "A list of values for the Company Category dropdown and their details.", "items": { "$ref": "#/components/schemas/front_office__CompanyCategory" } }, "companySources": { "type": "array", "description": "A list of values for the Company Sources dropdown and their details.", "items": { "$ref": "#/components/schemas/front_office__CompanySource" } } }, "additionalProperties": false }, "front_office__CompanyCategory": { "type": "object", "properties": { "categoryName": { "maxLength": 255, "type": "string", "description": "The name of the Company Category option.", "example": "Manufacturing" }, "categoryDetails": { "type": "array", "description": "A list of values for the Category Detail dropdown.", "items": { "$ref": "#/components/schemas/front_office__CategoryDetail" } } } }, "front_office__CategoryDetail": { "type": "object", "properties": { "categoryID": { "type": "integer", "description": "The identifier for the category.", "format": "int32", "example": 12345 }, "subCategory": { "maxLength": 255, "type": "string", "description": "A subcategory for the category.", "example": "Software Development" } }, "additionalProperties": false }, "front_office__CompanySource": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Company Source option.", "format": "int32", "example": 12345 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the Company Source option.", "example": "Referral" } }, "additionalProperties": false }, "front_office__ArrayOfCompanyTag": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__CompanyTag" } }, "front_office__ContactActivityDetailsDefinition": { "required": [ "id", "isArchived", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the contact activity detail definition.", "format": "int32", "example": 1 }, "name": { "type": "string", "description": "The name of the contact activity detail definition.", "example": "Left Voicemail" }, "isArchived": { "type": "boolean", "description": "An indication of whether the contact activity detail definition is archived or not.", "example": false } }, "additionalProperties": false }, "front_office__ArrayOfContactActivityDetailsDefinition": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__ContactActivityDetailsDefinition" } }, "front_office__ArrayOfContactTag": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__ContactTag" } }, "bo_prod__BurdenRate": { "required": [ "burdenGuid", "burdenRateGuid" ], "type": "object", "properties": { "burdenGuid": { "type": "string", "description": "The unique identifier for the Burden.", "format": "uuid", "example": "b8c9d0e1-2f3a-4b4c-5d6e-7f8091a2b3c4" }, "burdenRateGuid": { "type": "string", "description": "The unique identifier for the Burden Rate.", "format": "uuid", "example": "c9d0e1f2-3a4b-4c5d-6e7f-8091a2b3c4d5" }, "burdenName": { "type": "string", "description": "The name for this burden.", "example": "Workers Compensation" }, "category": { "type": "string", "description": "The category for the burden.", "example": "Insurance" }, "calcType": { "$ref": "#/components/schemas/bo_prod__BurdenCalcType" }, "rate": { "type": "number", "description": "The rate as a percentage for the burden.", "format": "decimal", "nullable": true, "example": 3.5 }, "burdenFactor": { "type": "number", "description": "A multiplier applied to the rate used for the burden calculation.", "format": "decimal", "example": 1 }, "rateStartDate": { "type": "string", "description": "The start date for the burden rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "rateEndDate": { "type": "string", "description": "The end date for the burden rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "nullable": true, "example": "2025-12-31T00:00:00Z" } } }, "bo_prod__BurdenCalcType": { "type": "string", "example": "TotalSales", "enum": [ "TotalSales", "NodeType" ] }, "bo_prod__EmployerTaxRate": { "type": "object", "properties": { "federalEmployerTaxRate": { "type": "number", "description": "The total federal employer tax rate, defined at a branch level.", "format": "decimal", "example": 6.2 }, "stateEmployerTaxRates": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__StateEmployerTaxRate" } } } }, "bo_prod__StateEmployerTaxRate": { "required": [ "taxId", "taxRateGuid" ], "type": "object", "properties": { "taxId": { "type": "integer", "description": "The unique identifier for the Employer Tax.", "format": "int32", "example": 1 }, "taxRateGuid": { "type": "string", "description": "The unique identifier for the Employer Tax Rate.", "format": "uuid", "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, "stateCode": { "type": "string", "description": "The two-character state code associated with the tax.", "example": "MN" }, "taxName": { "type": "string", "description": "The name of the employer tax.", "example": "State Unemployment Insurance" }, "taxRate": { "type": "number", "description": "The tax rate for the employer tax as a percentage.", "format": "decimal", "example": 3.15 }, "taxType": { "type": "string", "description": "The type of employer tax.", "example": "SUI" }, "startDate": { "type": "string", "description": "The start date for the employer tax rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "example": "2026-01-01T00:00:00Z" }, "endDate": { "type": "string", "description": "The end date for the employer tax rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "example": "2026-12-31T00:00:00Z" } } }, "bo_prod__WcCodeRate": { "required": [ "configWcCodeId", "configWcCodeRateGuid" ], "type": "object", "properties": { "configWcCodeId": { "type": "integer", "description": "The unique identifier for the Worker Comp Code.", "format": "int32", "example": 101 }, "configWcCodeRateGuid": { "type": "string", "description": "The unique identifier for the Worker Comp Code Rate, formatted as a UUID.", "format": "uuid", "example": "373a7c95-8e75-468e-b5dd-1a7351ff76e0" }, "workerCompCode": { "type": "string", "description": "A worker's compensation code, without the prefacing two-character state code.", "example": "8810" }, "description": { "type": "string", "description": "A description of the WC code, usually describing the job position or industry applicable to the code.", "nullable": true, "example": "Clerical Office Employees" }, "state": { "type": "string", "description": "The two-character code that often prefaces the WC code itself.", "example": "MN" }, "costPercent": { "type": "number", "description": "The cost rate for this WC code as a percentage.", "format": "decimal", "example": 1.25 }, "ratePercent": { "type": "number", "description": "The rate for this WC code as a percentage.", "format": "decimal", "example": 2.75 }, "wcEePercent": { "type": "number", "description": "The talent tax rate for this WC code, applicable to state-level taxes that have rates per WC code, such as WA LNI.", "format": "decimal", "example": 0.5 }, "wcErPercent": { "type": "number", "description": "The employer tax rate for this WC code, applicable to state-level taxes that have rates per WC Code, such as WA LNI.", "format": "decimal", "example": 1.1 }, "startDate": { "type": "string", "description": "The start date for the employer tax rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "example": "2026-01-01T00:00:00Z" }, "endDate": { "type": "string", "description": "The end date for the employer tax rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "example": "2026-12-31T00:00:00Z" } } }, "front_office__ReqEmploymentType": { "type": "object", "properties": { "empTypeID": { "type": "integer", "description": "The identifier for the employment type.", "format": "int32" }, "empTypeName": { "type": "string", "description": "The name of the employment type." }, "empTypeCategory": { "type": "string", "description": "The type of employment type. Acceptable values are W-2, 1099, C2C." }, "empTypeBurdenPercent": { "type": "number", "description": "The burden percentage for the employment type.", "format": "decimal" }, "empTypeCode": { "type": "string", "description": "The custom code for the employment type." }, "isDefault": { "type": "boolean", "description": "Identifies if the employment type is the default option for the tenant." } }, "additionalProperties": false }, "front_office__ArrayOfReqEmploymentType": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__ReqEmploymentType" } }, "back_office__ExternalReference": { "type": "object", "properties": { "boldId": { "type": "string", "description": "The BOLD identifier for the entity." }, "backOfficeId": { "type": "string", "description": "The Back Office identifier for the entity." }, "backOfficeUuid": { "type": "string", "description": "The unique identifier for an entity in the Back Office, representing the primary key when the key value is a GUID.", "format": "guid" }, "entityType": { "type": "string", "description": "The BOLD Entity type for the entity." } }, "additionalProperties": false }, "back_office__ArrayOfStringSchema": { "type": "array", "items": { "type": "string" } }, "back_office__ArrayOfExternalReference": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__ExternalReference" } }, "bo_prod__ExtraValueGetResponse": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/bo_prod__Extra" }, { "type": "object", "properties": { "extraValueProperty": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__ExtraValueProperty" } } } } ] }, "bo_prod__ExtraValueProperty": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/bo_prod__CustomSetupOptionProperty" } ] }, "front_office__ArrayOfApiUser": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__ApiUser" } }, "front_office__DepartmentAddressSearchDTO": { "required": [ "city", "companyID", "state", "street1", "zipcode" ], "type": "object", "properties": { "companyID": { "type": "integer", "description": "The identifier for the department's company.", "format": "int32" }, "street1": { "minLength": 1, "type": "string", "description": "The street 1 details of the department's address." }, "street2": { "type": "string", "description": "The street 2 details of the department's address." }, "city": { "minLength": 1, "type": "string", "description": "The name of the city of the department's address." }, "state": { "minLength": 1, "type": "string", "description": "The state/province of the department's address." }, "zipcode": { "minLength": 1, "type": "string", "description": "The zip code of the department's address" } }, "additionalProperties": false }, "front_office__JobActivityType": { "type": "object", "properties": { "act_type_id": { "type": "integer", "description": "The identifier for the activity type.", "format": "int32", "example": 12345 }, "act_type_name": { "maxLength": 255, "type": "string", "description": "The name of the activity type.", "example": "Submitted" }, "act_type_subtype": { "maxLength": 50, "type": "string", "description": "The subtype of the activity type.", "example": "General" }, "build_id": { "type": "integer", "description": "The identifier for the build.", "format": "int32", "example": 796 }, "act_type_order": { "type": "integer", "description": "Numeric order for the activity type in the list.", "format": "int32", "example": 1 }, "is_nom": { "type": "boolean", "description": "An indication of whether the activity type is a talent job nomination stage (Talent Stage) or not.", "example": true }, "is_pipe": { "type": "boolean", "description": "An indication of whether the activity type is a talent job pipeline stage or not.", "example": false }, "is_web": { "type": "boolean", "description": "An indication of whether the activity type is for a web application or not.", "example": false }, "manager_view": { "type": "boolean", "description": "An indication of whether the hiring manager can view the activity type or not.", "example": true }, "create_date": { "type": "string", "description": "The date the job activity type was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "stage_archive": { "type": "boolean", "description": "An indication of whether an activity type has been archived or not.", "example": false }, "is_vend": { "type": "boolean", "description": "An indication of whether the activity type is for a vendor or not.", "example": false }, "is_decline": { "type": "boolean", "description": "An indication of whether the type represents a \"declined\" activity or not.", "example": false }, "is_fallout": { "type": "boolean", "description": "An indication of whether it is an Early Termination Reason activity type or not." }, "is_extension": { "type": "boolean", "description": "An indication of whether it is a job extension activity or not.", "example": false }, "is_convertToPerm": { "type": "boolean", "description": "An indication of whether the activity is to convert a job to a permanent job or not.", "example": false }, "old_id": { "type": "integer", "description": "This property should be ignored.", "format": "int32" } }, "additionalProperties": false }, "front_office__ArrayOfJobActivityType": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__JobActivityType" } }, "front_office__JobOrderTemplate": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "companyId": { "type": "integer", "format": "int32" }, "companyName": { "type": "string" }, "officeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "front_office__ArrayOfJobOrderTemplate": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__JobOrderTemplate" } }, "front_office__SinglePostedJobResponse": { "type": "object", "properties": { "jobPostingID": { "type": "integer", "description": "The identifier for the job post.", "format": "int32", "example": 43566 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 234 }, "title": { "maxLength": 255, "type": "string", "description": "The job title on the job board.", "example": "Senior Clerical Officer" }, "description": { "type": "string", "description": "The job post description on the job board.", "example": "The role is responsible for clerical activities" }, "postedDateTime": { "type": "string", "description": "The date the job was posted. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "city": { "type": "string", "description": "The city where the job is located.", "example": "Dayton" }, "state": { "type": "string", "description": "The state or province where the job is located.", "example": "Ohio" }, "postalCode": { "type": "string", "description": "The postal code for the job location.", "example": "55149" }, "country": { "type": "string", "description": "The country where the job is located.", "example": "United States Of America" }, "jobBoardUrl": { "type": "string", "description": "The URL for the external job post.", "example": "https://jobs.example.com/postings/43566" }, "jobBoardArr": { "type": "array", "description": "The list of external job boards the job is posted on.", "items": { "$ref": "#/components/schemas/front_office__ExternalPosting" } } }, "additionalProperties": false }, "front_office__ExternalPosting": { "type": "object", "properties": { "externalJobBoardName": { "type": "string", "description": "The external job board name the job is posted on.", "example": "Indeed" } }, "additionalProperties": false }, "front_office__PostedJobResponse": { "type": "object", "properties": { "totalJobs": { "type": "integer", "description": "The total number of posted jobs returned in the page of results.", "format": "int32", "example": 10 }, "jobs": { "type": "array", "description": "The list of posted jobs returned in the page of results.", "items": { "type": "object", "description": "front_office__PostedJob (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } }, "additionalProperties": false }, "front_office__JobWorkSiteAddress": { "type": "object", "properties": { "addressId": { "type": "integer", "description": "The identifier for the address.", "format": "int32", "example": 123456 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 987654 }, "address1": { "type": "string", "description": "Street address, line 1.", "example": "123 Main St" }, "address2": { "type": "string", "description": "Street address, line 2.", "example": "Apt 4B" }, "city": { "maxLength": 255, "type": "string", "description": "City.", "example": "Los Angeles" }, "state": { "maxLength": 255, "type": "string", "description": "Province, state, or region.", "example": "CA" }, "postalCode": { "maxLength": 50, "type": "string", "description": "ZIP/postal code.", "example": "90001" }, "country": { "maxLength": 255, "type": "string", "description": "Country.", "example": "United States of America" } }, "additionalProperties": false }, "front_office__PostedJob": { "type": "object", "properties": { "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 123456 }, "workSiteAddress": { "description": "The worksite address for the job.", "oneOf": [ { "$ref": "#/components/schemas/front_office__JobWorkSiteAddress" } ] }, "employmentType": { "maxLength": 25, "type": "string", "description": "The type of employment.", "example": "Contract" }, "hourlyMinimum": { "type": "number", "description": "The minimum hourly pay rate for the job.", "format": "decimal", "example": 15 }, "hourlyMaximum": { "type": "number", "description": "The maximum hourly pay rate for the job.", "format": "decimal", "example": 25 }, "salaryMinimum": { "type": "number", "description": "The minimum salary for the job.", "format": "decimal", "example": 50000 }, "salaryMaximum": { "type": "number", "description": "The maximum salary for the job.", "format": "decimal", "example": 75000 }, "postedDate": { "type": "string", "description": "The date the job was posted. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "startDate": { "type": "string", "description": "The estimated start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "endDate": { "type": "string", "description": "The estimated end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "jobPostingID": { "type": "integer", "description": "The identifier for the job post.", "format": "int32", "example": 987654 }, "customJobDetails": { "type": "array", "description": "A list of custom job details.", "items": { "$ref": "#/components/schemas/front_office__CustomJobDetail" } }, "title": { "maxLength": 255, "type": "string", "description": "The job title on the job board.", "example": "Warehouse Associate" }, "jobBoardName": { "maxLength": 50, "type": "string", "description": "The job board name on the job post.", "example": "Indeed" }, "description": { "type": "string", "description": "The job description on the job board.", "example": "Responsible for picking, packing, and shipping orders." }, "requireResumeForWebApplicants": { "type": "boolean", "description": "An indication of whether a resume is required for applicants submitting applications through the web.", "example": true } }, "additionalProperties": false }, "front_office__PostedJobRequest": { "type": "object", "properties": { "jobId": { "type": "integer", "description": "The identifier for the job, if searching for a specific job.", "format": "int32", "example": 12345 }, "keywords": { "type": "string", "description": "The keywords to search for in the posted job title and description.", "example": "Warehouse" }, "city": { "maxLength": 255, "type": "string", "description": "The city to include in the job search.", "example": "Los Angeles" }, "state": { "maxLength": 255, "type": "string", "description": "The state or province to include in the job search.", "example": "CA" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The ZIP/postal code to include in the job search. It is required if radius is specified.", "example": "90001" }, "radius": { "maximum": 300, "type": "integer", "description": "The radius in miles for the job search, based on the postal code.", "format": "int32", "example": 25 }, "page": { "type": "integer", "description": "The page number to return in the paged results. Page 0 is the first page of results.", "format": "int32", "example": 0 }, "resultsPerPage": { "type": "integer", "description": "The number of jobs to return per page of results.", "format": "int32", "example": 10 } }, "additionalProperties": false }, "back_office__TalentJobSummary": { "type": "object", "properties": { "talentGuid": { "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "guid" }, "paycheckSummariesByYearAndBranch": { "type": "array", "description": "An array of objects representing paycheck data grouped by year and branch.", "items": { "$ref": "#/components/schemas/back_office__PaycheckYearSummary" } }, "rehireDate": { "type": "string", "description": "The date the talent was rehired. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.", "format": "date-time" }, "terminationDate": { "type": "string", "description": "The date the talent's employment was terminated. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.", "format": "date-time" }, "hireDate": { "type": "string", "description": "The date the talent was initially hired. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.", "format": "date-time" }, "firstPlacementGuid": { "type": "string", "description": "The unique identifier for the talent's first placement, formatted as a GUID.", "format": "guid" }, "firstPlacementStartDate": { "type": "string", "description": "The start date of the talent's first placement. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.", "format": "date-time" }, "latestPlacementGuid": { "type": "string", "description": "The unique identifier for the talent's latest placement, formatted as a GUID.", "format": "guid" }, "latestPlacementStartDate": { "type": "string", "description": "The start date of the talent's latest placement. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.", "format": "date-time" }, "firstPayrollCheckDate": { "type": "string", "description": "The date of the talent's first payroll check. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.", "format": "date-time" }, "latestPayrollCheckDate": { "type": "string", "description": "The date of the talent's latest payroll check. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.", "format": "date-time" } }, "additionalProperties": false }, "back_office__MultiQueryResultOfTalentJobSummaryAndGuid": { "type": "object", "properties": { "totalRequestedCount": { "type": "integer", "description": "The total number of talent job summaries requested in the query.", "format": "int32" }, "foundCount": { "type": "integer", "description": "The number of talent job summaries found and returned.", "format": "int32" }, "errorCount": { "type": "integer", "description": "The number of talent job summaries that could not be retrieved due to errors.", "format": "int32" }, "items": { "type": "array", "description": "Job summaries details.", "items": { "$ref": "#/components/schemas/back_office__TalentJobSummary" } }, "errors": { "type": "array", "description": "Error details.", "items": { "$ref": "#/components/schemas/back_office__MultiQueryErrorReasonOfGuid" } } }, "additionalProperties": false }, "back_office__MultiQueryErrorReasonOfGuid": { "type": "object", "properties": { "key": { "type": "string", "description": "The unique identifier associated with the error.", "format": "guid" }, "errorReason": { "type": "string", "description": "The reason or description explaining the error." } }, "additionalProperties": false }, "back_office__PaycheckYearSummary": { "type": "object", "properties": { "summaryTalentGuid": { "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "guid" }, "summaryBranchGuid": { "type": "string", "description": "The unique identifier for the branch associated with the summary.", "format": "guid" }, "summaryYear": { "type": "integer", "description": "The year for which the summary totals are calculated.", "format": "int32" }, "paycheckEmployerGuid": { "type": "string", "description": "The unique identifier for the employer associated with the paycheck data.", "format": "guid" }, "hoursWorkedYTD": { "type": "number", "description": "The total number of hours worked year-to-date by the talent.", "format": "decimal" }, "grossWagesYTD": { "type": "number", "description": "The total gross wages earned year-to-date by the talent.", "format": "decimal" }, "grossPaidYTD": { "type": "number", "description": "The total gross amount paid year-to-date to the talent.", "format": "decimal" }, "paidEmployeePlacementGuids": { "type": "array", "description": "A list of placement identifiers for employee placements that received payment.", "items": { "type": "string", "format": "guid" } }, "paidContractPlacementGuids": { "type": "array", "description": "A list of placement identifiers for contract placements that received payment.", "items": { "type": "string", "format": "guid" } } }, "additionalProperties": false }, "back_office__ArrayOfGuids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "front_office__ArrayOfJob": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__Job" } }, "front_office__TalentPipeline": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the pipelined talent.", "format": "int32", "example": 189482 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 175529 }, "source": { "type": "integer", "description": "The identifier for the source.", "format": "int32", "example": 488 }, "pipelineStage": { "maxLength": 255, "type": "string", "description": "The current pipeline stage for the talent for a specific job.", "example": "Pipelined" }, "pipelinedDate": { "type": "string", "description": "The date the talent was pipelined for a job. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z.", "format": "date-time", "example": "2024-12-01T14:30:00.546Z" }, "pipelinedUser": { "type": "integer", "description": "The identifier for the user that added the talent to the pipeline stage for a job.", "format": "int32", "example": 24398 }, "nominatedDate": { "type": "string", "description": "The date when the talent was nominated for a job. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "declinedDate": { "type": "string", "description": "The date when the nomination was declined. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" } }, "additionalProperties": false }, "front_office__ArrayOfTalentPipeline": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentPipeline" } }, "front_office__NewCompanyRequirements": { "type": "object", "properties": { "companyName": { "type": "boolean", "description": "A flag indicating name may be required when creating a new company.", "example": true }, "companyRep": { "type": "boolean", "description": "A flag indicating at least one representativeUser may be required when creating a new company.", "example": true }, "country": { "type": "boolean", "description": "A flag indicating mainAddress/country may be required when creating a new company.", "example": true }, "address1": { "type": "boolean", "description": "A flag indicating mainAddress/street1 may be required when creating a new company.", "example": true }, "address2": { "type": "boolean", "description": "A flag indicating mainAddress/street2 may be required when creating a new company.", "example": true }, "city": { "type": "boolean", "description": "A flag indicating mainAddress/city may be required when creating a new company.", "example": true }, "state": { "type": "boolean", "description": "A flag indicating mainAddress/state_Province may be required when creating a new company.", "example": true }, "zip": { "type": "boolean", "description": "A flag indicating mainAddress/postalCode may be required when creating a new company.", "example": true }, "status": { "type": "boolean", "description": "A flag indicating status may be required when creating a new company.", "example": true }, "website": { "type": "boolean", "description": "A flag indicating link may be required when creating a new company.", "example": true }, "mainPhone": { "type": "boolean", "description": "Not implemented." }, "industry": { "type": "boolean", "description": "A flag indicating industry may be required when creating a new company.", "example": true }, "category": { "type": "boolean", "description": "Not implemented." }, "tag": { "type": "boolean", "description": "Not implemented." } }, "additionalProperties": false }, "front_office__NewTalentRequirement": { "type": "object", "properties": { "firstName": { "type": "boolean", "description": "A flag indicating firstName may be required when creating a new talent.", "example": true }, "lastName": { "type": "boolean", "description": "A flag indicating lastName may be required when creating a new talent.", "example": true }, "country": { "type": "boolean", "description": "A flag indicating residentAddress/country may be required when creating a new talent.", "example": true }, "address": { "type": "boolean", "description": "A flag indicating residentAddress/street1 may be required when creating a new talent.", "example": true }, "city": { "type": "boolean", "description": "A flag indicating residentAddress/city may be required when creating a new talent.", "example": true }, "state": { "type": "boolean", "description": "A flag indicating residentAddress/state_Province may be required when creating a new talent.", "example": true }, "zip": { "type": "boolean", "description": "A flag indicating residentAddress/postalCode may be required when creating a new talent.", "example": true }, "phone": { "type": "boolean", "description": "A flag indicating mobilePhone, homePhone or workPhone may be required when creating a new talent.", "example": true }, "email": { "type": "boolean", "description": "A flag indicating emailAddress may be required when creating a new talent.", "example": true }, "linkedInProfile": { "type": "boolean", "description": "Not implemented." }, "personalSite": { "type": "boolean", "description": "Not implemented." }, "custom1": { "type": "boolean", "description": "Not implemented." }, "custom2": { "type": "boolean", "description": "Not implemented." }, "skills": { "type": "boolean", "description": "Not implemented." }, "applicantTags": { "type": "boolean", "description": "Not implemented." }, "resume": { "type": "boolean", "description": "Not implemented." }, "region": { "type": "boolean", "description": "Not implemented." }, "currentCompany": { "type": "boolean", "description": "Not implemented." }, "applicantSource": { "type": "boolean", "description": "Not implemented." }, "industryExperience": { "type": "boolean", "description": "Not implemented." }, "workHistoryCompany": { "type": "boolean", "description": "Not implemented." }, "workHistoryPosition": { "type": "boolean", "description": "Not implemented." }, "educationHistorySchool": { "type": "boolean", "description": "Not implemented." }, "educationDegree": { "type": "boolean", "description": "Not implemented." }, "educationField": { "type": "boolean", "description": "Not implemented." } }, "additionalProperties": false }, "front_office__AdobeESignDocument": { "type": "object", "properties": { "documentId": { "type": "integer", "description": "The identifier for the onboarding document record.", "format": "int32", "example": 28925 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 138942 }, "documentName": { "type": "string", "description": "The file name of the document.", "example": "Federal W4.pdf" }, "documentType": { "type": "string", "description": "The type of the document.", "example": "FederalW4" }, "dateCreated": { "type": "string", "description": "The date on which the onboarding document was sent to the talent. The field follows the YYYY-MM-DDTHH:mm:ss format and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01T14:30:00+00:00, and 2024-12-01T14:30:00.546+00:00.", "format": "date-time" }, "createdBy": { "type": "integer", "description": "The BOLD ID of the user who sent the onboarding document to the talent.", "format": "int32", "example": 62874 }, "verifiedBy": { "type": "integer", "description": "BOLD ID of the user that verified the onboarding document.", "format": "int32", "example": 62874 }, "verifiedDate": { "type": "string", "description": "The date on which the onboarding document was verified. The field follows the YYYY-MM-DDTHH:mm:ss format and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01T14:30:00+00:00, and 2024-12-01T14:30:00.546+00:00.", "format": "date-time" }, "documentContents": { "type": "string", "description": "The Base-64 encoded contents of the document." }, "isFailedLoadContent": { "type": "boolean", "description": "An indicator of whether the retreival of document contents from Adobe failed.", "example": true }, "failedLoadContentError": { "type": "string", "description": "The error that occurred while retrieving the document contents from Adobe.", "example": "Document not found" } }, "additionalProperties": false }, "back_office__PaidTalentSearchParameters": { "required": [ "checkEndDate", "checkStartDate", "supplierGuid" ], "type": "object", "properties": { "supplierGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the staffing company (supplier), formatted as a UUID.", "format": "guid" }, "checkStartDate": { "minLength": 1, "type": "string", "description": "The start date of the paycheck date range used to calculate total wages. Provide only the date without any time information, in any valid format (for example, YYYY-MM-DD or MM-DD-YYYY).", "format": "date-time" }, "checkEndDate": { "minLength": 1, "type": "string", "description": "The end date of the paycheck date range used to calculate total wages. Provide only the date without any time information, in any valid format (for example, YYYY-MM-DD or MM-DD-YYYY).", "format": "date-time" } } }, "back_office__PagedResultsOfGuid": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/back_office__IPagedResultsOfGuid" }, { "required": [ "totalCount" ], "type": "object", "properties": { "pageSize": { "type": "integer", "description": "The number of items to be displayed on one page.", "format": "int32" }, "currentPage": { "type": "integer", "description": "The current page number.", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages.", "format": "int32" } } } ] }, "back_office__IPagedResultsOfGuid": { "required": [ "totalCount" ], "type": "object", "properties": { "totalCount": { "type": "integer", "description": "The total number of items.", "format": "int32" }, "results": { "type": "array", "items": { "type": "string", "description": "The current page results.", "format": "uuid" } } } }, "front_office__ArrayOfBenefitPartnerReference": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BenefitPartnerReference" } }, "front_office__BenefitPartnerReference": { "type": "object", "properties": { "referenceKey": { "type": "string", "description": "The name of the reference group." }, "referenceValue": { "type": "string", "description": "The reference value." } }, "additionalProperties": false }, "back_office__BulkDataPage": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/back_office__PaginationResponse" }, "pageData": { "type": "array", "description": "An array of objects included on the current page.", "items": { "type": "object" } } }, "additionalProperties": false }, "back_office__PaginationResponse": { "type": "object", "properties": { "totalResults": { "type": "integer", "description": "The total number of results.", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of results included per page.", "format": "int32" }, "currentPage": { "type": "integer", "description": "The current page number.", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages available.", "format": "int32" } }, "additionalProperties": false }, "back_office__TalentBenefitTransactionType": { "type": "object", "properties": { "transactionTypeId": { "type": "integer", "description": "The unique identifier for the talent benefit transaction type.", "format": "int32" }, "name": { "type": "string", "description": "The display name of the transaction type." }, "systemName": { "type": "string", "description": "The internal system name of the transaction type." }, "deductionCategoryId": { "type": "integer", "description": "The unique identifier for the deduction category associated with the transaction type.", "format": "int32" }, "isEmployeeDeduction": { "type": "boolean", "description": "An indication of whether the transaction type represents an employee deduction." }, "isEmployerContribution": { "type": "boolean", "description": "An indication of whether the transaction type represents an employer contribution." }, "isPreTax": { "type": "boolean", "description": "An indication of whether the transaction type is categorized as pre-tax." }, "isPayCode": { "type": "boolean", "description": "An indication of whether the transaction type is a paycode." } }, "additionalProperties": false }, "back_office__PayrollContribution": { "required": [ "accountingPeriodDate", "paymentCheckContributionGuid", "paymentCheckGuid", "supplierGuid", "talentGuid" ], "type": "object", "properties": { "paymentCheckContributionGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the paymentcheck contribution, formatted as a UUID.", "format": "guid" }, "supplierGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the Staffing Supplier, formatted as a UUID.", "format": "guid" }, "accountingPeriodDate": { "type": "string", "description": "The date of accounting period the payroll was completed in.", "format": "date-time" }, "paymentCheckGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the paycheck, formatted as a UUID.", "format": "guid" }, "talentGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "guid" }, "employeeContributionGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the Employee contribution.", "format": "guid" }, "transactionTypeId": { "type": "integer", "description": "The unique identifier for the deduction type.", "format": "int32" }, "checkNumber": { "type": "string", "description": "The Check Number for the PaymentCheck." }, "checkDate": { "type": "string", "description": "The Check Date for the PaymentBatch.", "format": "date-time" }, "contributionAmount": { "type": "number", "description": "The total amount deducted from the talent's paycheck.", "format": "decimal" }, "contributionAmountYtd": { "type": "number", "description": "The Year to Date total for the deduction for the talent.", "format": "decimal" }, "deductionAmountLtd": { "type": "number", "description": "The Life Time total for the deduction for the talent.", "format": "decimal" } }, "additionalProperties": false }, "back_office__ArrayOfPayrollContribution": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__PayrollContribution" } }, "back_office__PayrollDeduction": { "required": [ "accountingPeriodDate", "paymentCheckDeductionGuid", "paymentCheckGuid", "supplierGuid", "talentGuid" ], "type": "object", "properties": { "paymentCheckDeductionGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the paymentcheck deduction, formatted as a UUID.", "format": "guid" }, "supplierGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the Staffing Supplier, formatted as a UUID.", "format": "guid" }, "accountingPeriodDate": { "type": "string", "description": "The date of accounting period the payroll was completed in.", "format": "date-time" }, "paymentCheckGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the paycheck, formatted as a UUID.", "format": "guid" }, "talentGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "guid" }, "employeeDeductionGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the Employee deduction.", "format": "guid" }, "transactionTypeId": { "type": "integer", "description": "The unique identifier for the deduction type.", "format": "int32" }, "checkNumber": { "type": "string", "description": "The Check Number for the PaymentCheck." }, "checkDate": { "type": "string", "description": "The Check Date for the PaymentBatch.", "format": "date-time" }, "deductionAmount": { "type": "number", "description": "The total amount deducted from the talent's paycheck.", "format": "decimal" }, "deductionAmountYtd": { "type": "number", "description": "The Year to Date total for the deduction for the talent.", "format": "decimal" }, "deductionAmountLtd": { "type": "number", "description": "The Life Time total for the deduction for the talent.", "format": "decimal" } }, "additionalProperties": false }, "back_office__ArrayOfPayrollDeduction": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__PayrollDeduction" } }, "bo_prod__ArrayOfPayrollPeriodOptions": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__PayrollPeriodOption" } }, "bo_prod__PayrollPeriodOption": { "type": "object", "properties": { "payrollPeriodId": { "type": "integer", "description": "The unique identifier for the payroll period option.", "format": "int32", "example": 1 }, "payrollPeriodName": { "$ref": "#/components/schemas/bo_prod__PayPeriod" }, "validPayrollCycles": { "type": "array", "description": "The list of payroll cycles that are valid for the selected payroll period option.", "example": [ "1" ], "items": { "type": "string" } } } }, "bo_prod__PayPeriod": { "type": "string", "example": "Weekly", "enum": [ "Unknown", "Weekly", "BiWeekly", "Monthly", "SemiMonthly", "Daily", "Yearly", "Hourly" ] }, "back_office__ByteStringSchema": { "type": "string", "format": "byte" }, "front_office__EndReason": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the Placement End Reason.", "format": "int32", "example": 12345 }, "name": { "maxLength": 500, "type": "string", "description": "The name of the Placement End Reason.", "example": "Contract Completed" }, "endReasonType": { "type": "string", "description": "The type of the Placement End Reason. Possible values are: 'Positive', 'Negative', 'Unknown'.", "example": "Positive" } }, "additionalProperties": false }, "front_office__ArrayOfEndReason": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__EndReason" } }, "back_office__MultiQueryResultOfPlacementAndGuid": { "type": "object", "properties": { "totalRequestedCount": { "type": "integer", "description": "The total number of placement records requested in the query.", "format": "int32" }, "foundCount": { "type": "integer", "description": "The number of placement records found and returned.", "format": "int32" }, "errorCount": { "type": "integer", "description": "The number of placement records that could not be retrieved due to errors.", "format": "int32" }, "items": { "type": "array", "description": "Placement records details.", "items": { "$ref": "#/components/schemas/back_office__Placement" } }, "errors": { "type": "array", "description": "Error details.", "items": { "$ref": "#/components/schemas/back_office__MultiQueryErrorReasonOfGuid" } } }, "additionalProperties": false }, "back_office__Placement": { "type": "object", "properties": { "placementGuid": { "type": "string", "description": "The unique identifier for the placement, formatted as a GUID.", "format": "uuid", "x-disabled-for-amazon-gateway": { "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, "example": null }, "branchGuid": { "type": "string", "description": "The unique identifier for the branch associated with the talent, formatted as a GUID.", "format": "uuid", "x-disabled-for-amazon-gateway": { "example": "8d7372c0-1cbd-4d06-8656-252a7143910c" }, "example": null }, "backOfficeAssignmentId": { "type": "integer", "description": "The ID of the Assignment in the Back Office.", "format": "int32", "x-disabled-for-amazon-gateway": { "example": 123 }, "example": null }, "WorkSiteAddress": { "$ref": "#/components/schemas/back_office__Address" }, "isW2": { "type": "boolean", "description": "An indication of whether the placement is a W2 placement (true) or a contract placement (false).", "x-disabled-for-amazon-gateway": { "example": true }, "example": null }, "agencyGuid": { "type": "string", "description": "The vendor agency GUID, used when the placement is a contract placement (IsW2 = false) and payment should be directed to the vendor instead of the talent.", "format": "uuid", "x-disabled-for-amazon-gateway": { "example": "" }, "example": null }, "jobTitle": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Job title for the placement, as defined on the Job.", "x-disabled-for-amazon-gateway": { "example": "Front Desk" }, "example": null }, "payPeriod": { "$ref": "#/components/schemas/back_office__PayPeriod" }, "placementSchedules": { "type": "array", "description": "A list of all schedules associated with the placement.", "items": { "type": "object", "description": "back_office__PlacementSchedule (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } }, "additionalProperties": false }, "back_office__PlacementSchedule": { "type": "object", "properties": { "placementScheduleGuid": { "type": "string", "description": "The unique identifier for the placement schedule, formatted as a GUID.", "format": "uuid", "x-disabled-for-amazon-gateway": { "example": "7e1ac026-5c4c-49e7-aa1d-3f75d823f133" }, "example": null }, "startDate": { "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Start date of the placement schedule in YYYY-MM-DD format, without a timestamp.", "format": "date", "x-disabled-for-amazon-gateway": { "example": "2025-01-01T00:00:00.000+00:00" }, "example": null }, "endDate": { "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "End date of the placement schedule in YYYY-MM-DD format, without a timestamp.", "format": "date", "x-disabled-for-amazon-gateway": { "example": "2025-01-30T00:00:00.000+00:00" }, "example": null }, "isActive": { "type": "boolean", "description": "An indication of whether the schedule is active. Only one schedule can be active for a placement.", "x-disabled-for-amazon-gateway": { "example": true }, "example": null }, "placementRates": { "type": "array", "description": "A list of all rates for the particular placement schedule.", "items": { "type": "object", "description": "back_office__PlacementRate (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } }, "additionalProperties": false }, "back_office__PlacementRate": { "type": "object", "properties": { "placementRateGuid": { "type": "string", "description": "The unique identifier for the placement rate, formatted as a GUID.", "format": "uuid", "x-disabled-for-amazon-gateway": { "example": "880e8c9e-459f-4322-8ea8-21b6fd6f2230" }, "example": null }, "transactionTypeId": { "type": "integer", "description": "The unique identifier for the pay/bill code.", "format": "int32", "x-disabled-for-amazon-gateway": { "example": 1 }, "example": null }, "transactionType": { "maxLength": 25, "type": "string", "description": "The pay or bill code associated with the transaction.", "x-disabled-for-amazon-gateway": { "example": "Reg" }, "example": null }, "payRate": { "type": "number", "description": "Pay rate for the particular pay/bill code.", "format": "decimal", "x-disabled-for-amazon-gateway": { "example": 10.5 }, "example": null }, "billRate": { "type": "number", "description": "Bill rate for the particular pay/bill code.", "format": "decimal", "x-disabled-for-amazon-gateway": { "example": 15.99 }, "example": null } }, "additionalProperties": false }, "front_office__JobStandardTitle": { "type": "object", "properties": { "standardJobTitleId": { "type": "integer", "description": "The identifier for the standard job title.", "format": "int32" }, "standardJobTitle": { "maxLength": 255, "type": "string", "description": "The standard job title." }, "standardJobTitleDescription": { "maxLength": 255, "type": "string", "description": "The standard job title description." }, "standardJobCategoryId": { "type": "integer", "description": "The identifier for the standard job title category." }, "standardJobCategory": { "maxLength": 255, "type": "string", "description": "The standard job title category." }, "frontOfficeIds": { "type": "array", "description": "Office IDs the Standard Job Title can be accessed from.", "items": { "type": "integer", "format": "int32" } }, "socCode": { "maxLength": 7, "pattern": "^[0-9]{2}-[0-9]{4}$", "type": "string", "description": "The Standard Occupational Classification (SOC) code mapped to the standard job title in the Table Editor. SOC codes are only used for U.S. jobs." }, "socCodeTitle": { "maxLength": 250, "type": "string", "description": "The Standard Occupational Classification (SOC) title mapped to the standard job title in the Table Editor. SOC codes are only used for U.S. jobs." } }, "additionalProperties": false }, "front_office__ArrayOfJobStandardTitle": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__JobStandardTitle" } }, "front_office__SubmitterTerms": { "required": [ "last_modified_date", "terms_id", "terms_text" ], "type": "object", "properties": { "terms_id": { "type": "integer", "description": "The identifier of the account's configured Submitter Terms record. A value of `0` indicates that _Submitter Terms_ are not configured for the account.", "format": "int32", "example": 101 }, "terms_text": { "type": "string", "description": "The attestation text presented to a worker when submitting a timesheet. `Null` when _Submitter Terms_ are not configured for the account.", "nullable": true, "example": "I certify that the hours reported are accurate and complete." }, "last_modified_date": { "type": "string", "description": "The date and time when the account's Submitter Terms were last updated. `Null` when _Submitter Terms_ are not configured for the account. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The account's configured timesheet Submitter Terms. All properties are always present." }, "back_office__Supplier": { "type": "object", "properties": { "supplierGuid": { "type": "string", "description": "The unique identifier for the Supplier, formatted as a UUID.", "format": "uuid", "x-disabled-for-amazon-gateway": { "example": "184fd8fc-6d06-f011-87a7-a0595061251e" }, "example": null }, "shortName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Short Name of the Supplier.", "x-disabled-for-amazon-gateway": { "example": "ABC Staffing" }, "example": null }, "fullName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Full Name of the Supplier.", "x-disabled-for-amazon-gateway": { "example": "ABC Staffing Inc." }, "example": null }, "fein": { "maxLength": 10, "type": "string", "description": "Federal Tax EIN of the Supplier.", "x-disabled-for-amazon-gateway": { "example": "987654321" }, "example": null }, "phoneNumber": { "$ref": "#/components/schemas/back_office__PhoneNumber" }, "address": { "$ref": "#/components/schemas/back_office__Address" } } }, "back_office__ArrayOfSupplier": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__Supplier" } }, "front_office__TalentAllTagsList": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32" }, "skills": { "type": "array", "description": "A list of Skill Set Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentSkill" } }, "talentTags": { "type": "array", "description": "A list of Talent Tags and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentTag" } }, "resumeSkills": { "type": "array", "description": "A list of Resume Skill Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__TalentResumeSkill" } }, "customTalentTags": { "type": "array", "description": "A list of Custom Talent Tags for the talent and their details.", "items": { "$ref": "#/components/schemas/front_office__CustomTalentTag" } }, "customFields": { "description": "A list of up to 3 Custom Fields for the talent and their details.", "oneOf": [ { "$ref": "#/components/schemas/front_office__TalentCustomFields" } ] } }, "additionalProperties": false }, "front_office__CustomTalentTag": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the custom talent tag.", "format": "int32", "example": 18275 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 148853 }, "category": { "maxLength": 255, "type": "string", "description": "The custom category name of the custom tag", "example": "Language" }, "customTagId": { "type": "integer", "description": "The identifier for the custom tag option.", "format": "int32", "example": 827 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the custom tag option.", "example": "Spanish" }, "expirationDate": { "type": "string", "description": "The expiration date of the Custom Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" } }, "additionalProperties": false }, "bo_prod__Talent": { "required": [ "firstName", "lastName", "talentGuid" ], "type": "object", "properties": { "talentGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the Talent, formatted as a UUID.", "format": "uuid", "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, "branchGuid": { "type": "string", "description": "The unique identifier for the Branch associated with the Talent, formatted as a UUID.", "format": "uuid", "example": "8d7372c0-1cbd-4d06-8656-252a7143910c" }, "backOfficeEmployeeId": { "type": "integer", "description": "The identifier for the Talent in the Back Office.", "format": "int32", "example": 10542 }, "firstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The first name of the talent.", "example": "Jane" }, "middleName": { "maxLength": 50, "type": "string", "description": "The middle name of the talent.", "example": "Marie" }, "lastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The last name of the talent.", "example": "Smith" }, "residentAddress": { "$ref": "#/components/schemas/bo_prod__TalentAddress" }, "taxIdNumber": { "maxLength": 50, "type": "string", "description": "The national identification number used for federal taxes. For talent with resident address in the U.S. or Canada, this value may be provided as digits only or in the format 111-111-1111 and must be valid for the country of residence to be saved.", "nullable": true, "example": "111-11-1111" }, "dateOfBirth": { "type": "string", "description": "The date of birth of the talent. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "nullable": true, "example": "1990-05-05T00:00:00Z" }, "mobilePhone": { "maxLength": 20, "type": "string", "description": "The primary mobile phone number of the talent, chosen from the __Cell__ field. If multiple entries exist, the most recent one is selected.", "example": "555-0100" }, "emailAddress": { "maxLength": 50, "type": "string", "description": "The primary email address of the talent, chosen from the __Email__ field. If multiple entries exist, the most recent one is selected.", "example": "jane.smith@example.com" }, "gender": { "$ref": "#/components/schemas/bo_prod__Gender" }, "checkDeliveryOptionId": { "type": "integer", "description": "The identifier for the talent's check delivery option.", "format": "int32", "nullable": true, "example": 2 } }, "additionalProperties": false }, "bo_prod__TalentAddress": { "required": [ "addressGuid", "country" ], "type": "object", "properties": { "addressGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the address, formatted as a UUID.", "format": "uuid", "example": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d" }, "street1": { "maxLength": 255, "type": "string", "description": "The primary street address.", "example": "123 Main St" }, "street2": { "maxLength": 255, "type": "string", "description": "An additional street address.", "example": "Suite 400" }, "city": { "maxLength": 255, "type": "string", "description": "The city of the address.", "example": "Eagan" }, "postalCode": { "maxLength": 15, "type": "string", "description": "The postal code associated with the address.", "example": "55121" }, "state": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The state associated with the address.", "example": "MN" }, "country": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The country associated with the address.", "example": "US" } }, "additionalProperties": false }, "bo_prod__Gender": { "type": "string", "description": "Gender.", "example": "F", "enum": [ "UNKNOWN", "M", "F", "N", "X" ] }, "back_office__Talent1095c": { "type": "object", "properties": { "form1095cId": { "type": "string", "description": "Globally unique identifier for Form 1095-C.", "format": "guid" }, "employerName": { "type": "string", "description": "The name of the employer (staffing supplier)." }, "taxYear": { "type": "string", "description": "The taxation year the form is issued in." } }, "additionalProperties": false }, "back_office__ArrayOfTalent1095c": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__Talent1095c" } }, "front_office__Talent1099Company": { "type": "object", "properties": { "id": { "type": "integer", "description": "The talent's ID.", "format": "int32", "example": 187481 }, "companyName": { "maxLength": 255, "type": "string", "description": "The talent's company name.", "example": "ABC Corp" }, "address1": { "maxLength": 255, "type": "string", "description": "The talent's company address, line 1.", "example": "123 Corporate Drive" }, "address2": { "maxLength": 255, "type": "string", "description": "The talent's company address, line 2.", "example": "Suite 100" }, "city": { "maxLength": 50, "type": "string", "description": "The talent's company city.", "example": "Bloomington" }, "state": { "maxLength": 50, "type": "string", "description": "The talent's company state.", "example": "MN" }, "zipCode": { "maxLength": 50, "type": "string", "description": "The talent's company zip/postal code.", "example": "55423" }, "ein": { "maxLength": 255, "type": "string", "description": "The talent's EIN.", "example": "12-1234567" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The talent's company phone number.", "example": "651-555-5555" } }, "additionalProperties": false }, "back_office__Talent1099": { "type": "object", "properties": { "quarterGuid": { "type": "string", "description": "Globally unique identifier for a quarter.", "format": "guid" }, "employerName": { "type": "string", "description": "The name of the employer (staffing supplier)." }, "taxYear": { "type": "integer", "description": "The taxation year the form is issued in.", "format": "int32" }, "nonEmployeeCompensation": { "type": "number", "description": "The amount of non-employee compensation.", "format": "decimal" } }, "additionalProperties": false }, "back_office__ArrayOfTalent1099": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__Talent1099" } }, "bo_prod__AccrualPlanOption": { "type": "object", "properties": { "configAccrualPlanGuid": { "type": "string", "description": "The unique identifier for the Accrual Plan.", "format": "uuid", "example": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c" }, "staffingSupplierGuid": { "type": "string", "description": "The unique identifier for the Division associated with this accrual plan.", "format": "uuid", "example": "cc63d8fc-6d06-f011-87a7-a0595061251e" }, "accrualPlan": { "type": "string", "description": "The name of the accrual plan in plain text.", "example": "PTO" }, "description": { "type": "string", "description": "The description for this accrual plan in plain text.", "example": "Standard paid time off accrual plan." }, "rate": { "type": "number", "description": "The default rate at which this plan accrues usable time off.", "format": "decimal", "example": 0.0385 }, "accrualRateTypeOption": { "$ref": "#/components/schemas/bo_prod__AccrualRateTypeOption" }, "payPeriodLimit": { "type": "number", "description": "The default number of units the plan is allowed to accrue per pay period.", "format": "decimal", "example": 4 }, "yearlyLimit": { "type": "number", "description": "The default number of units the plan is allowed to accrue per year.", "format": "decimal", "example": 80 }, "maximumAccrualBalance": { "type": "number", "description": "The default maximum number of units the employee can accrue on this plan per year.", "format": "decimal", "example": 120 }, "initialBalance": { "type": "number", "description": "The default number of units to add to the plan balance upon initial setup.", "format": "decimal", "example": 0 }, "unlimitedCarryover": { "type": "boolean", "description": "A default boolean value indicating whether this plan has a limit to the number of units the talent is allowed to carry over year over year.", "example": false }, "allowedCarryover": { "type": "number", "description": "The default number of units a talent is allowed to carry over into the next accrual year. Only used if the plan is not configured with unlimited carryover.", "format": "decimal", "example": 40 }, "accrualDateTypeOption": { "$ref": "#/components/schemas/bo_prod__AccrualDateTypeOption" }, "active": { "type": "boolean", "description": "An indication of whether this plan is active at a system level.", "example": true }, "processingMethod": { "type": "string", "description": "The processing method for the accrual plan.", "example": "RG" }, "accrualPayTypeOption": { "$ref": "#/components/schemas/bo_prod__AccrualPayTypeOption" }, "autoInsert": { "type": "boolean", "description": "An indication of whether this plan should automatically be inserted on talent records when the time entry batch is closed.", "example": false }, "suppressionDays": { "type": "integer", "description": "An integer value representing the number of days this plan is hidden from view from the talent. Used in scenarios in which the talent does not have access to use the plan for a specific number of days.", "example": 0 } } }, "bo_prod__AccrualPayTypeOption": { "type": "string", "description": "An option used to define the pay type for talent accrual plans. Used only for Canadian accrual plans.", "example": "IncludeInWeeklyPay", "enum": [ "IncludeInWeeklyPay", "AccrueForLaterPayout", "Unknown" ] }, "front_office__TalentTaskDto": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 292918 }, "taskId": { "type": "integer", "description": "The identifier for the task.", "format": "int32", "example": 592845 }, "taskTypeId": { "type": "integer", "description": "The identifier for the task type.", "format": "int32", "example": 2846 }, "taskType": { "maxLength": 255, "type": "string", "description": "The name of the task type.", "example": "Review Company Handbook" }, "createDate": { "type": "string", "description": "The date the task was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "taskDate": { "type": "string", "description": "The UTC date-time the task was started. The field follows the YYYY-MM-DDTHH:mm:ss format in UTC time, for example, 2024-12-01T14:30:00Z.", "format": "date-time" }, "startTime": { "type": "string", "description": "The UTC date-time the task was started. The field follows the YYYY-MM-DDTHH:mm:ss format in UTC time, for example, 2024-12-01T14:30:00Z.", "format": "date-time" }, "endTime": { "type": "string", "description": "The UTC date-time the task was completed. The field follows the YYYY-MM-DDTHH:mm:ss format in UTC time, for example, 2024-12-01T14:30:00Z.", "format": "date-time" }, "timeZoneId": { "maxLength": 255, "type": "string", "description": "The timezone location of the task.", "example": "Central Standard Time" }, "taskUserId": { "type": "integer", "description": "The identifier for the user that created the task.", "format": "int32", "example": 13459 }, "taskNotes": { "type": "string", "description": "The description of the task.", "example": "Please review the company handbook and sign the acknowledgement page." } }, "additionalProperties": false }, "front_office__TalentAssessment": { "type": "object", "properties": { "applicantAssessmentId": { "type": "integer", "description": "The identifier for the assessment associated with a talent.", "format": "int32", "example": 42280 }, "sessionStatus": { "maxLength": 100, "type": "string", "description": "The status of the assessment.", "example": "Completed" }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 189482 }, "providerAssessmentId": { "type": "string", "description": "The provider identifier for the assessment.", "format": "guid", "example": "EDDD9D28-DE39-4563-88DC-1930D6C6F748" }, "providerAssessmentName": { "maxLength": 100, "type": "string", "description": "The provider name for the assessment.", "example": "Basic Spelling" }, "providerType": { "maxLength": 100, "type": "string", "description": "The name of the provider.", "example": "SHL" }, "completedDateTime": { "type": "string", "description": "The date and time when the assessment was completed. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "totalQuestions": { "type": "integer", "description": "The total number of questions within the specified assessment.", "format": "int32", "example": 25 }, "questionsCorrect": { "type": "integer", "description": "The total number of questions answered correctly within the specified assessment.", "format": "int32", "example": 24 }, "displayScore": { "maxLength": 2000, "type": "string", "description": "The display score of the specified assessment.", "example": "87 %tile" }, "overallEvaluationText": { "maxLength": 20, "type": "string", "description": "The overall evaluation text for the specified assessment.", "example": "Pass" }, "overallScoreType": { "maxLength": 100, "type": "string", "description": "The overall score type for the specified assessment.", "example": "Percentile" }, "overallNumericScore": { "type": "integer", "description": "The overall numeric score achieved by the talent in the specified assessment.", "format": "int32", "example": 87 }, "rawScore": { "type": "number", "description": "The raw score obtained by the talent in the specified assessment.", "format": "double", "example": 87 }, "tscore": { "type": "number", "description": "The T-score obtained by the talent in the specified assessment.", "format": "double", "example": 49.993 }, "zscore": { "type": "number", "description": "The Z-score obtained by the talent in the specified assessment.", "format": "double", "example": 0.584 } }, "additionalProperties": false }, "front_office__ArrayOfTalentAssessment": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentAssessment" } }, "back_office__ArrayOfTalentBenefit": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__TalentBenefit" } }, "back_office__BulkDataPageOfPayrollDeduction": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/back_office__PaginationResponse" }, "pageData": { "type": "array", "description": "An array of objects included on the current page.", "items": { "$ref": "#/components/schemas/back_office__PayrollDeduction" } } }, "additionalProperties": false }, "back_office__ArrayOfBenefitPartnerReference": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__BenefitPartnerReference" } }, "back_office__BenefitPartnerReference": { "required": [ "referenceKey", "referenceValue" ], "type": "object", "properties": { "referenceKey": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The name of the reference group." }, "referenceValue": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The reference value." } }, "additionalProperties": false }, "back_office__ArrayOfTalentBenefitYtdSummary": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__TalentBenefitYtdSummary" } }, "back_office__TalentBenefitYtdSummary": { "type": "object", "properties": { "talentGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "guid" }, "supplierGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the staffing company (supplier), formatted as a GUID. This is used to identify the supplier associated with the talent's benefit.", "format": "guid" }, "grossWagesYtd": { "type": "number", "description": "The total gross wages earned year-to-date by the talent.", "format": "double" }, "hoursYtd": { "type": "number", "description": "The total hours worked year-to-date by the talent.", "format": "double" }, "payrollDeductions": { "type": "array", "description": "The list of payroll deductions for the talent, including the deduction type and year-to-date amount.", "items": { "type": "object", "description": "back_office__TalentBenefitYtdDeductionSummary (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "payrollContributions": { "type": "array", "description": "The list of payroll contributions for the talent, including the contribution type and year-to-date amount.", "items": { "type": "object", "description": "back_office__TalentBenefitYtdContributionSummary (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } }, "additionalProperties": false }, "back_office__TalentBenefitYtdDeductionSummary": { "type": "object", "properties": { "employeeDeductionGuid": { "type": "string", "description": "A unique identifier for the talent benefit deduction, formatted as a GUID.", "format": "guid" }, "transactionTypeId": { "type": "integer", "description": "The unique identifier for the transaction type.", "format": "int32" }, "transactionTypeName": { "type": "string", "description": "The display name of the transaction type." }, "deductionAmountYtd": { "type": "number", "description": "The year-to-date total deduction amount for the talent and the supplier.", "format": "decimal" } }, "additionalProperties": false }, "back_office__TalentBenefitYtdContributionSummary": { "type": "object", "properties": { "employeeContributionGuid": { "type": "string", "description": "A unique identifier for the talent benefit contribution, formatted as a GUID.", "format": "guid" }, "transactionTypeId": { "type": "integer", "description": "The unique identifier for the transaction type.", "format": "int32" }, "transactionTypeName": { "type": "string", "description": "The display name of the transaction type." }, "contributionAmountYtd": { "type": "number", "description": "The year-to-date total contribution amount for the talent and the supplier.", "format": "decimal" } }, "additionalProperties": false }, "front_office__TalentCertificateDocument": { "type": "object", "properties": { "talentCertificateUploadId": { "type": "integer", "description": "The identifier of the talent's certificate document upload.", "format": "int32", "example": 284 }, "talentCertificateID": { "type": "integer", "description": "The identifier of the talent's certificate.", "format": "int32", "example": 2399 }, "fileName": { "maxLength": 255, "type": "string", "description": "The title of the document with the file extension.", "example": "Example Certificate.pdf" }, "uploadedBy": { "type": "integer", "description": "The identifier of the user who uploaded the document.", "format": "int32", "example": 18925 }, "uploadedDateUtc": { "type": "string", "description": "The date and UTC time when the document was uploaded. UTC timestamp in ISO 8601 format (e.g., 2025-06-09T14:30:00Z).", "format": "date-time" }, "expirationDateUtc": { "type": "string", "description": "The expiration date and UTC time of the document. UTC timestamp in ISO 8601 format (e.g., 2025-06-09T14:30:00Z).", "format": "date-time" }, "fileContents": { "type": "string", "description": "The Base-64 encoded contents of the document.", "format": "byte" } }, "additionalProperties": false }, "front_office__ArrayOfTalentCertificateDocument": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentCertificateDocument" } }, "front_office__ArrayOfTalentCertificate": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentCertificate" } }, "front_office__TalentCommPreference": { "required": [ "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent Communication Preference.", "format": "int32", "example": 2825 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 17845 }, "email": { "type": "boolean", "description": "The setting for the talent email preference.", "example": false }, "sms": { "type": "boolean", "description": "The setting for the talent sms/text messaging preference.", "example": true }, "inApp": { "type": "boolean", "description": "The setting for the talent in app notification preference.", "example": true }, "lastUpdated": { "type": "string", "description": "The date and time for the talent last updated activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" } }, "additionalProperties": false }, "back_office__TalentDeduction": { "required": [ "supplierGuid", "talentGuid", "transactionTypeId" ], "type": "object", "properties": { "talentGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "guid" }, "supplierGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the staffing company (supplier), formatted as a GUID. This is used to identify the supplier associated with the talent's benefit.", "format": "guid" }, "transactionTypeId": { "type": "integer", "description": "The unique identifier for the talent benefit transaction type.", "format": "int32" }, "TransactionTypeName": { "type": "string", "description": "The display name of the transaction type." }, "isPreTax": { "type": "boolean", "description": "An indication of whether the transaction type is a pretax vs posttax deduction." }, "sequence": { "type": "integer", "description": "The sequence of the talent deduction that is needs to be deducted.", "format": "int32" } }, "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/back_office__TalentBenefitDeduction" } ] }, "back_office__ArrayOfTalentDeduction": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__TalentDeduction" } }, "front_office__DirectDepositBankAccount": { "description": "A direct deposit account that extends __BankAccount__ with prenotification dates and archive state.", "allOf": [ { "$ref": "#/components/schemas/front_office__BankAccount" }, { "type": "object", "properties": { "isArchived": { "type": "boolean", "description": "An indication of whether the account has been archived (soft-deleted). A value of `true` indicates the account is archived, and `false` indicates the account is active. This property is distinct from `isActivated`, which reflects Pay Card activation state rather than the account's archive state.", "example": false }, "prenoteSentDate": { "type": "string", "description": "The date and time the prenotification was sent to the bank. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "nullable": true }, "prenoteApproveDate": { "type": "string", "description": "The date and time the prenotification was approved. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.", "format": "date-time", "nullable": true } } } ] }, "front_office__ArrayOfDirectDepositBankAccount": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__DirectDepositBankAccount" } }, "front_office__ArrayOfTalentDocumentLink": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentDocumentLink" } }, "front_office__TalentDocumentLink": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent document.", "format": "int32", "example": 28925 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 1328925 }, "fileName": { "maxLength": 255, "type": "string", "description": "The encrypted name of the file with extension that is generated by Avionté.", "example": "5jBlQJ8WSqJ67dNSMxLBDy2f.docx" }, "documentTitle": { "maxLength": 500, "type": "string", "description": "The title of the document.", "example": "John Doe Resume.docx" }, "documentDate": { "type": "string", "description": "The date when the document was uploaded. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "documentType": { "maxLength": 50, "type": "string", "description": "The type of the BOLD document.", "example": "Resume" }, "uploadedBy": { "type": "integer", "description": "The ID of the user who uploaded the document.", "format": "int32", "example": 123948 }, "isPrivate": { "type": "boolean", "description": "An indication of whether the document is private or not.", "example": false }, "isShared": { "type": "boolean", "description": "An indication of whether the document is shared or not.", "example": true }, "expiryDate": { "type": "string", "description": "The expiration date of the document. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "documentTypeId": { "type": "integer", "description": "The identifier for the BOLD document type.", "format": "int32", "example": 59245 }, "employerId": { "type": "integer", "description": "The identifier for the employer.", "format": "int32", "example": 234 }, "isVisible": { "type": "boolean", "description": "An indication of whether the document is visible or not.", "example": true }, "preSignedUrl": { "type": "string", "description": "A pre-signed URL that can be used to download the document contents.", "example": "https://s3.amazonaws.com/bucket/document.pdf?AWSAccessKeyId=ACCESS_KEY&Expires=EXPIRATION_TIME&Signature=SIGNATURE" } }, "additionalProperties": false }, "front_office__ArrayOfTalentDocument": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentDocument" } }, "front_office__TalentDocument": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent document.", "format": "int32", "example": 28925 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 1328925 }, "fileName": { "maxLength": 255, "type": "string", "description": "The encrypted name of the file with extension that is generated by Avionté.", "example": "5jBlQJ8WSqJ67dNSMxLBDy2f.docx" }, "fileContent": { "type": "string", "description": "The content of the file to be uploaded. It will be populated using the content of the attached file. Valid file extensions are: 'txt', 'doc', 'docx', 'pdf', 'xls', 'xlsx', 'png', 'jpg', 'jpeg'.", "format": "binary" }, "documentTitle": { "maxLength": 500, "type": "string", "description": "The title of the document.", "example": "John Doe Resume.docx" }, "documentDate": { "type": "string", "description": "The date when the document was uploaded. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "documentType": { "maxLength": 50, "type": "string", "description": "The type of the BOLD document.", "example": "Resume" }, "uploadedBy": { "type": "integer", "description": "The ID of the user who uploaded the document.", "format": "int32", "example": 123948 }, "isPrivate": { "type": "boolean", "description": "An indication of whether the document is private or not.", "example": false }, "isShared": { "type": "boolean", "description": "An indication of whether the document is shared or not.", "example": true }, "expiryDate": { "type": "string", "description": "The expiration date of the document. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "documentTypeId": { "type": "integer", "description": "The identifier for the BOLD document type.", "format": "int32", "example": 59245 }, "employerId": { "type": "integer", "description": "The identifier for the employer.", "format": "int32", "example": 234 }, "isVisible": { "type": "boolean", "description": "An indication of whether the document is visible or not.", "example": true }, "documentContent": { "type": "string", "description": "The contents of the talent document as a Base-64 encoded string.", "format": "byte" } }, "additionalProperties": false }, "front_office__ArrayOfTalentDocTypes": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentDocTypes" } }, "front_office__TalentDocTypes": { "type": "object", "properties": { "documentTypeId": { "type": "integer", "description": "The identifier for the document type.", "format": "int32", "example": 274 }, "documentType": { "maxLength": 50, "type": "string", "description": "The type of the document.", "example": "Other" }, "isArchived": { "type": "boolean", "description": "An indication of whether the talent document type is archived or not.", "example": false } }, "additionalProperties": false }, "back_office__TalentMultiQuery": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/back_office__MultiQueryResponseBase" }, { "$ref": "#/components/schemas/back_office__MultiQueryPartialErrorItems" }, { "type": "object", "properties": { "successItems": { "type": "array", "description": "List of retrieved entity records.", "items": { "$ref": "#/components/schemas/back_office__Talent" } } } } ] }, "back_office__TalentMultiQuerySuccess": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/back_office__MultiQueryResponseBase" }, { "type": "object", "properties": { "successItems": { "type": "array", "description": "List of retrieved entity records.", "items": { "$ref": "#/components/schemas/back_office__Talent" } } } } ] }, "back_office__MultiQueryResponseBase": { "type": "object", "properties": { "totalRequestedCount": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Number of records request by multi-query request.", "x-disabled-for-amazon-gateway": { "example": 25 } }, "foundCount": { "minimum": 0, "type": "integer", "description": "Number of successfully retrieved entity records.", "x-disabled-for-amazon-gateway": { "example": 1 } }, "errorCount": { "minimum": 0, "type": "integer", "description": "Number of requested records where the entity record could not be returned.", "x-disabled-for-amazon-gateway": { "example": 1 } } } }, "back_office__MultiQueryPartialErrorItems": { "type": "object", "properties": { "errorItems": { "type": "array", "description": "List of unique identifiers for the entity records that failed to be retrieved and the error reason.", "items": { "type": "object", "description": "back_office__MultiQueryPartialError (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } } }, "back_office__MultiQueryPartialError": { "type": "object", "properties": { "key": { "type": "string", "description": "Unique identifier of entity record which was not returned." }, "errorReason": { "type": "string", "description": "Reason entity could not be returned by multi-query request.", "x-disabled-for-amazon-gateway": { "example": "Not Found" } } } }, "back_office__Talent": { "required": [ "firstName", "lastName", "talentGuid" ], "type": "object", "properties": { "talentGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "uuid" }, "branchGuid": { "type": "string", "description": "The unique identifier for the branch associated with the talent, formatted as a GUID.", "format": "uuid" }, "backOfficeEmployeeId": { "type": "integer", "description": "The ID of the employee in the Back Office.", "format": "int32" }, "firstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The first name of the talent." }, "middleName": { "maxLength": 50, "type": "string", "description": "The middle name of the talent." }, "lastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The last name of the talent." }, "residentAddress": { "$ref": "#/components/schemas/back_office__TalentAddress" }, "taxIdNumber": { "maxLength": 50, "type": "string", "description": "National identification number used for federal taxes. For talent with resident address in the USA or Canada, this value can be provided as digits only or in the format 111-111-1111 and must be valid for the country of residence to be saved." }, "dateOfBirth": { "type": "string", "description": "The date of birth of the talent.", "format": "date-time" }, "mobilePhone": { "maxLength": 20, "type": "string", "description": "The primary mobile phone number of the talent, chosen from the Cell field. If multiple entries exist, the most recent one is selected." }, "emailAddress": { "maxLength": 50, "type": "string", "description": "The primary email address of the talent, chosen from the Email field. If multiple entries exist, the most recent one is selected." }, "gender": { "$ref": "#/components/schemas/back_office__Gender" }, "checkDeliveryOptionId": { "type": "integer", "description": "The identifier for the check delivery option of the talent.", "format": "int32" } }, "additionalProperties": false }, "back_office__TalentAddress": { "required": [ "addressGuid", "country" ], "type": "object", "properties": { "addressGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the address, formatted as a GUID.", "format": "uuid" }, "street1": { "maxLength": 255, "type": "string", "description": "The primary street address." }, "street2": { "maxLength": 255, "type": "string", "description": "An additional street address." }, "city": { "maxLength": 255, "type": "string", "description": "The city of the address." }, "postalCode": { "maxLength": 15, "type": "string", "description": "The postal code associated with the address." }, "state": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The state associated with the address." }, "country": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The country associated with the address." } }, "additionalProperties": false }, "back_office__Gender": { "type": "string", "description": "Gender.", "enum": [ "UNKNOWN", "M", "F", "N", "X" ] }, "front_office__TalentOnboardingTaskDto": { "type": "object", "properties": { "taskName": { "type": "string", "description": "The Name for a talent onboarding task.", "example": "Clerical Questionnaire" }, "state": { "type": "string", "description": "The State or Status for a talent onboarding task. Valid values are \n Assigned, \n Initiated, \n VerificationRequired, \n Completed, \n Rejected, \n Deleted, \n OverDue.", "example": "Completed" } }, "additionalProperties": false }, "front_office__ArrayOfTalentOnboardingTaskDto": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentOnboardingTaskDto" } }, "back_office__TalentPayCheckDetailV2": { "type": "object", "properties": { "paymentCheckGuid": { "type": "string", "description": "Globally unique identifier for the paycheck.", "format": "guid" }, "checkNumber": { "type": "string", "description": "The check number." }, "checkDate": { "type": "string", "description": "The date the check was issued.", "format": "date-time" }, "grossAmount": { "type": "number", "description": "The total gross amount of pay for the check.", "format": "decimal" }, "netAmount": { "type": "number", "description": "The total net amount of pay for the check.", "format": "decimal" }, "totalTaxes": { "type": "number", "description": "The total dollar amount of taxes deducted from the paycheck.", "format": "decimal" }, "totalDeductions": { "type": "number", "description": "The dollar amount of deductions taken out of check.", "format": "decimal" }, "isDirectDeposit": { "type": "boolean", "description": "An indication of whether direct deposit was used for a check." }, "ytdGross": { "type": "number", "description": "The dollar amount of total pay earned by an employee when the check was filed.", "format": "decimal" }, "totalHours": { "type": "number", "description": "The total number of hours worked by an employee during the date range.", "format": "decimal" }, "talentPayCheckTransaction": { "type": "array", "description": "A list of paycheck transactions and their details.", "items": { "$ref": "#/components/schemas/back_office__TalentPayCheckTransactionV2" } }, "talentPayCheckTax": { "type": "array", "description": "A list of paycheck taxes and their details.", "items": { "$ref": "#/components/schemas/back_office__TalentPayCheckTaxV2" } }, "talentPayCheckDeduction": { "type": "array", "description": "A list of talent paycheck deductions and their details.", "items": { "$ref": "#/components/schemas/back_office__TalentPayCheckDeductionV2" } }, "talentPayCheckAccrual": { "type": "array", "description": "A list of paycheck accruals and their details.", "items": { "$ref": "#/components/schemas/back_office__TalentPayCheckAccrualV2" } }, "talentPayCheckBenefit": { "type": "array", "description": "A list of paycheck benefits and their details.", "items": { "$ref": "#/components/schemas/back_office__TalentPayCheckBenefitV2" } }, "talentPayCheckBank": { "type": "array", "description": "A list of accounts and dollar amounts that the paycheck was distributed to.", "items": { "$ref": "#/components/schemas/back_office__TalentPayCheckBankV2" } } }, "additionalProperties": false }, "back_office__TalentPayCheckTransactionV2": { "type": "object", "properties": { "transactionType": { "type": "string", "description": "The type of transaction." }, "rate": { "type": "number", "description": "Pay rate from transaction.", "format": "decimal" }, "hours": { "type": "number", "description": "Hours from transaction.", "format": "double" }, "pay": { "type": "number", "description": "Pay from transaction.", "format": "decimal" } }, "additionalProperties": false }, "back_office__TalentPayCheckTaxV2": { "type": "object", "properties": { "taxId": { "type": "integer", "description": "The identifier for the tax.", "format": "int32" }, "taxName": { "type": "string", "description": "The name of the tax." }, "taxableGross": { "type": "number", "description": "Total taxable amount.", "format": "decimal" }, "taxAmount": { "type": "number", "description": "Total tax amount deducted from the paycheck.", "format": "decimal" }, "taxAmountYTD": { "type": "number", "description": "Total tax amount that has been deducted from paychecks for the year to date.", "format": "decimal" }, "taxableGrossYTD": { "type": "number", "description": "Total taxable amount year to date.", "format": "decimal" } }, "additionalProperties": false }, "back_office__TalentPayCheckDeductionV2": { "type": "object", "properties": { "deductionName": { "type": "string", "description": "The type of the deduction." }, "deductionAmount": { "type": "number", "description": "Amount of the deduction.", "format": "decimal" }, "deductionAmountYTD": { "type": "number", "description": "Year to date amount of deduction.", "format": "decimal" }, "deductionAmountLTD": { "type": "number", "description": "Life to date amount of deduction.", "format": "decimal" }, "isPermanent": { "type": "boolean", "description": "An indicator of whether it is a permanent recurring deduction or a one-time deduction." } }, "additionalProperties": false }, "back_office__TalentPayCheckAccrualV2": { "type": "object", "properties": { "planName": { "type": "string", "description": "The name of the accrual plan." }, "accruedUnit": { "type": "number", "description": "An accrued unit in the paycheck.", "format": "decimal" }, "depleteUnit": { "type": "number", "description": "A depleted unit in the paycheck.", "format": "decimal" }, "remainingBalance": { "type": "number", "description": "The remaining balance of accrued units.", "format": "decimal" } }, "additionalProperties": false }, "back_office__TalentPayCheckBenefitV2": { "type": "object", "properties": { "benefitName": { "type": "string", "description": "The type of the benefit." }, "benefitAmount": { "type": "number", "description": "The amount of benefit.", "format": "decimal" }, "benefitAmountYTD": { "type": "number", "description": "Year to date amount of benefit.", "format": "decimal" }, "benefitAmountLTD": { "type": "number", "description": "Life to date amount of benefit.", "format": "decimal" } }, "additionalProperties": false }, "back_office__TalentPayCheckBankV2": { "type": "object", "properties": { "accountType": { "type": "string", "description": "The type of the account." }, "amountType": { "type": "string", "description": "The type of the amount." }, "last4AccountNumber": { "type": "string", "description": "Last four digits of the account number." }, "amount": { "type": "number", "description": "The dollar amount distributed to the account for the paycheck.", "format": "decimal" }, "amountYTD": { "type": "number", "description": "The year to date dollar amount distributed to the account.", "format": "decimal" } }, "additionalProperties": false }, "back_office__PagedResultsOfTalentPayCheckV2": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/back_office__IPagedResultsOfTalentPayCheckV2" }, { "type": "object", "properties": { "pageSize": { "type": "integer", "description": "The number of items to be displayed on one page.", "format": "int32" }, "currentPage": { "type": "integer", "description": "The current page number.", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages.", "format": "int32" } }, "additionalProperties": false } ] }, "back_office__IPagedResultsOfTalentPayCheckV2": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "The total number of items.", "format": "int32" }, "results": { "type": "array", "description": "The paged results.", "items": { "$ref": "#/components/schemas/back_office__TalentPayCheckV2" } } }, "additionalProperties": false }, "back_office__TalentPayCheckV2": { "type": "object", "properties": { "paymentCheckGuid": { "type": "string", "description": "Globally unique identifier for the paycheck.", "format": "guid" }, "checkNumber": { "type": "string", "description": "The check number." }, "checkDate": { "type": "string", "description": "The date the check was issued.", "format": "date-time" }, "grossAmount": { "type": "number", "description": "The total gross amount of pay for the check.", "format": "decimal" }, "netAmount": { "type": "number", "description": "The total net amount of pay for the check.", "format": "decimal" }, "totalTaxes": { "type": "number", "description": "The total dollar amount of taxes deducted from the paycheck.", "format": "decimal" }, "totalDeductions": { "type": "number", "description": "The dollar amount of deductions taken out of check.", "format": "decimal" }, "isDirectDeposit": { "type": "boolean", "description": "An indication of whether direct deposit was used for a check." }, "ytdGross": { "type": "number", "description": "The dollar amount of total pay earned by an employee when a check was filed.", "format": "decimal" }, "totalHours": { "type": "number", "description": "The total number of hours worked by an employee during the date range.", "format": "decimal" } }, "additionalProperties": false }, "front_office__TalentProfilePayRequirements": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 17847 }, "salaryMin": { "type": "number", "description": "For direct hires, the minimum salary required by the talent.", "format": "decimal", "example": 65000 }, "salaryMax": { "type": "number", "description": "For direct hires, the maximum salary sought by the talent.", "format": "decimal", "example": 85000 }, "salaryDetails": { "type": "string", "description": "Considerations for salary requirements such as mileage reimbursement, relocation fees, benefits requirements, and other compensation-related factors.", "nullable": true, "example": "Open to relocation with assistance; requires medical benefits." }, "hourlyMin": { "type": "number", "description": "The minimum hourly rate for temporary or contracted talent.", "format": "decimal", "example": 25 }, "hourlyMax": { "type": "number", "description": "The maximum hourly rate for temporary or contracted talent.", "format": "decimal", "example": 40 }, "hourlyDetails": { "type": "string", "description": "Considerations and requirements for hourly workers, such as scheduling preferences, shift availability, and other work requirements.", "nullable": true, "example": "Available for first and second shift; no weekends." }, "bypassBonusAccrual": { "type": "boolean", "description": "An indication of whether bonus accrual is bypassed for the talent.", "example": false } }, "additionalProperties": false }, "front_office__PlacementExtension": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the placement.", "format": "int32", "example": 123456 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 789012 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 345678 }, "extensionIdList": { "type": "array", "description": "The list of identifiers for all of the placement extensions for the placement.", "example": [ 901234, 567890 ], "items": { "type": "integer", "format": "int32" } }, "originalStartDate": { "type": "string", "description": "The placement original start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "finalEndDate": { "type": "string", "description": "The placement final end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "isActive": { "type": "boolean", "description": "An indication of whether the placement is active or not.", "example": true }, "employmentType": { "description": "Employment type information.", "oneOf": [ { "$ref": "#/components/schemas/front_office__EmploymentType" } ] }, "frontOfficeId": { "type": "integer", "description": "The identifier for the placement's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.", "format": "int32", "example": 123 }, "hiredDate": { "type": "string", "description": "The date the talent was hired. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "endReasonId": { "type": "integer", "description": "The identifier for the end reason.", "format": "int32", "example": 456 }, "endReason": { "maxLength": 500, "type": "string", "description": "The reason for ending the placement.", "example": "Contract completed" }, "enteredByUserId": { "type": "integer", "description": "The identifier for the user who entered the placement record.", "format": "int32", "example": 78934 }, "enteredByUser": { "maxLength": 255, "type": "string", "description": "The email of the user who entered the placement record.", "example": "john.doe@example.com" }, "recruiterUserId": { "type": "integer", "description": "The identifier for the recruiter user.", "format": "int32", "example": 12345 }, "recruiterUser": { "maxLength": 255, "type": "string", "description": "The email of the recruiter user.", "example": "john.doe@example.com" }, "createdByUserId": { "type": "integer", "description": "The identifier for the user who created the placement.", "format": "int32", "example": 67890 }, "createdDate": { "type": "string", "description": "The date when the placement was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "origin": { "maxLength": 50, "type": "string", "description": "The origin of the placement.", "example": "Partner XYZ" }, "reqEmploymentType": { "maxLength": 15, "type": "string", "description": "The employment type code for the placement.", "example": "1099" }, "reqEmploymentTypeName": { "maxLength": 50, "type": "string", "description": "The display name of the employment type for the placement.", "example": "1099 Contractor" }, "approvers": { "type": "array", "description": "The list of approvers attached to the placement across all extensions. Empty array when no approvers exist.", "items": { "type": "object", "description": "front_office__PlacementApprover (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } }, "flsaClassification": { "type": "string", "description": "The Fair Labor Standards Act (FLSA) classification for the placement, which determines the talent's eligibility for overtime pay. Valid values are `Exempt`, `NonExempt`, and `None`.", "example": "Exempt", "enum": [ "Exempt", "NonExempt", "None" ] }, "workScheduleType": { "type": "string", "description": "The expected work schedule for the placement. Valid values are `Full-Time`, `Part-Time`, `Intermittent`, and `None`.", "example": "Full-Time", "enum": [ "Full-Time", "Part-Time", "Intermittent", "None" ] }, "remoteWork": { "type": "boolean", "description": "An indication of whether the placement is a remote work arrangement.", "example": false } }, "additionalProperties": false }, "front_office__Questionnaire": { "type": "object", "properties": { "appAnswerId": { "type": "integer", "description": "The identifier for the answer.", "format": "int32", "example": 7824 }, "reqId": { "type": "integer", "description": "The identifier for the request.", "format": "int32", "example": 5672 }, "reqQuestion": { "type": "string", "description": "The question asked in the questionnaire.", "example": "How many years of experience?" }, "reqAnswer": { "type": "string", "description": "The answer provided by the talent.", "example": "5 years" }, "reqAnswerCorrect": { "type": "boolean", "description": "An indication of whether the talent's answer is correct or not.", "example": true }, "reqQuestionScore": { "type": "integer", "description": "The total score received by the talent for the specified question.", "format": "int32", "example": 90 }, "reqQuestionType": { "maxLength": 50, "type": "string", "description": "The type of question.", "example": "Essay" } }, "additionalProperties": false }, "front_office__ApplicantQuestionnaire": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 123129 }, "questionGroup": { "type": "integer", "description": "The identifier for the questionnaire.", "format": "int32", "example": 773 }, "questionGroupName": { "maxLength": 200, "type": "string", "description": "The name of the questionnaire.", "example": "Onboarding Questions" }, "questionnaire": { "type": "array", "description": "Details about the questionnaire.", "items": { "$ref": "#/components/schemas/front_office__Questionnaire" } } }, "additionalProperties": false }, "front_office__ArrayOfApplicantQuestionnaire": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__ApplicantQuestionnaire" } }, "back_office__ArrayOfTalentT4A": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__TalentT4A" } }, "back_office__TalentT4A": { "type": "object", "properties": { "supplierGuid": { "type": "string", "description": "The globally inique identifier for the staffing company (supplier).", "format": "guid" }, "taxYear": { "type": "integer", "description": "The taxation year the form is issued in.", "format": "int32" }, "name": { "type": "string", "description": "The name of the employer (staffing supplier)." } }, "additionalProperties": false }, "back_office__ArrayOfTalentT4": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__TalentT4" } }, "back_office__TalentT4": { "type": "object", "properties": { "supplierGuid": { "type": "string", "description": "The unique identifier for the staffing company (supplier), formatted as a UUID.", "format": "guid" }, "taxYear": { "type": "string", "description": "The taxation year Form T-4 is issued in." }, "name": { "type": "string", "description": "The name of the employer (staffing supplier)." }, "employmentIncome": { "type": "number", "description": "Employment income which includes not only wages but also any vacation, bonuses, and taxable benefits, often a summary of several T4 boxes.", "format": "decimal" }, "cppContribution": { "type": "number", "description": "The amount of Canada Pension Plan (CPP) contributions.", "format": "decimal" }, "eiPremium": { "type": "number", "description": "The amount of EI premiums.", "format": "decimal" }, "incomeTax": { "type": "number", "description": "Total amount deducted from the pay for income tax (Federal and Provincial).", "format": "decimal" } }, "additionalProperties": false }, "front_office__CompanyExperienceOption": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the company experience option.", "format": "int32", "example": 734 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the company experience option.", "example": "ABC Corp" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "front_office__TalentTagDefinitions": { "type": "object", "properties": { "certifications": { "type": "array", "description": "A list of values for the Certification dropdown and their details.", "items": { "$ref": "#/components/schemas/front_office__Certification" } }, "citizenship": { "type": "array", "description": "A list of values for the Citizenship dropdown and their details.", "items": { "$ref": "#/components/schemas/front_office__CitizenshipType" } }, "candidateSources": { "type": "array", "description": "A list of values for the Source dropdown and their details.", "items": { "$ref": "#/components/schemas/front_office__CandidateSource" } }, "companies": { "type": "array", "description": "A list of values for the Company Experience dropdown and their details.", "items": { "$ref": "#/components/schemas/front_office__CompanyExperienceOption" } }, "customTags": { "type": "array", "description": "A list of Custom Tags and their details.", "items": { "$ref": "#/components/schemas/front_office__CustomTag" } }, "industries": { "type": "array", "description": "A list of values for the Industry Experience dropdown and their details.", "items": { "$ref": "#/components/schemas/front_office__IndustryExperienceOption" } }, "quickSearchTitles": { "type": "array", "description": "A list of values for the QuickSearch dropdown and their details.", "items": { "$ref": "#/components/schemas/front_office__QuickSearchTitle" } }, "skills": { "type": "array", "description": "A list of values for the Skill Set dropdown and their details.", "items": { "$ref": "#/components/schemas/front_office__Skill" } } }, "additionalProperties": false }, "front_office__CitizenshipType": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the citizenship type option.", "format": "int32", "example": 295 }, "name": { "maxLength": 100, "type": "string", "description": "The name of the citizenship type option.", "example": "Citizen" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "front_office__CandidateSource": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the candidate Source option.", "format": "int32", "example": 293 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the candidate Source option.", "example": "LinkedIn" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "front_office__QuickSearchTitle": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the quick search title option.", "format": "int32", "example": 582 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the quick search title option.", "example": "Accounting" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "front_office__Certification": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the certification option.", "format": "int32", "example": 589 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the certification option.", "example": "Forklift Certified" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "front_office__CustomTag": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "The identifier for the category option.", "format": "int32", "example": 827 }, "category": { "maxLength": 255, "type": "string", "description": "The name of the category option.", "example": "Language" }, "detailId": { "type": "integer", "description": "The identifier for the detail option.", "format": "int32", "example": 288 }, "detail": { "maxLength": 255, "type": "string", "description": "The name of the detail option.", "example": "Spanish" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "front_office__IndustryExperienceOption": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the industry experience option.", "format": "int32", "example": 289 }, "name": { "maxLength": 255, "type": "string", "description": "The name of the industry experience option.", "example": "Retail" }, "frontOfficeTenantId": { "type": "integer", "description": "The unique identifier that represents a client.", "format": "int32", "example": 796 } }, "additionalProperties": false }, "back_office__TalentTaxDetail": { "required": [ "talentGuid", "taxId" ], "type": "object", "properties": { "talentTaxGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the talent tax record, formatted as a GUID. Not applicable for Federal W-4.", "format": "guid" }, "federalW4Id": { "type": "integer", "description": "The unique identifier for the talent federal W-4. Only applicable for Federal W-4.", "format": "int32" }, "talentGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "guid" }, "taxId": { "type": "integer", "description": "The unique identifier of the tax record.", "format": "int32" }, "taxName": { "type": "string", "description": "The name of the tax record." }, "employeeTax": { "type": "boolean", "description": "An indication of whether the tax is Employee Tax or Employer Tax." }, "stateCode": { "type": "string", "description": "The two-character code for a state or province." }, "taxType": { "type": "string", "description": "The type of tax. Possible values include: Federal Income Tax, State Income Tax, FUTA, SUI, FICA, MEDICARE, Local, and others." }, "taxFilingStatusId": { "type": "integer", "description": "The unique identifier for the tax filing status.", "format": "int32" }, "TaxFilingStatus": { "type": "string", "description": "The tax filing status." }, "exemptions": { "type": "number", "description": "The number of exemptions. Not applicable for Federal W-4.", "format": "decimal" }, "dependents": { "type": "number", "description": "The number of dependents. Not applicable for Federal W-4.", "format": "decimal" }, "additionalWithholding": { "type": "number", "description": "The additional withholding amount.", "format": "decimal" }, "fixedPercentage": { "type": "number", "description": "The percentage withholding value. Not applicable for Federal W-4.", "format": "decimal" }, "fixedAmount": { "type": "number", "description": "The fixed amount withholding value. Not applicable for Federal W-4.", "format": "decimal" }, "active": { "type": "boolean", "description": "An indication of whether the tax is active or not." }, "isTaxExempt": { "type": "boolean", "description": "An indication of whether the tax is exempt or not." }, "exemptionAmount": { "type": "boolean", "description": "The exemption amount. Not applicable for Federal W-4." }, "supplierGuid": { "type": "string", "description": "The unique identifier for the staffing company (supplier), formatted as a GUID. Only applicable for Federal W-4.", "format": "guid" }, "supplierName": { "type": "string", "description": "The name of the employer (staffing supplier). Only applicable for Federal W-4." }, "hasMultipleJobs": { "type": "boolean", "description": "An indication of whether the talent has multiple jobs. Only applicable for Federal W-4." }, "qualifyingChildren": { "type": "number", "description": "The number of qualifying children. Only applicable for Federal W-4.", "format": "int32" }, "otherDependents": { "type": "number", "description": "The number of other dependents. Only applicable for Federal W-4.", "format": "int32" }, "totalDependents": { "type": "number", "description": "The number of total dependents. Only applicable for Federal W-4.", "format": "int32" }, "otherIncome": { "type": "number", "description": "Other income. Only applicable for Federal W-4.", "format": "decimal" }, "deductions": { "type": "number", "description": "Deductions. Only applicable for Federal W-4.", "format": "decimal" }, "firstWorkedDate": { "type": "string", "description": "The first date the talent worked. Only applicable for Federal W-4. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.", "format": "date-time" }, "dateCompleted": { "type": "string", "description": "The date the Federal W-4 was completed. Only applicable for Federal W-4. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.", "format": "date-time" }, "usWithholdingType": { "type": "string", "description": "The US withholding type. Only applicable for US taxes." } }, "additionalProperties": false }, "back_office__ArrayOfTalentTaxDetail": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__TalentTaxDetail" } }, "bo_prod__TaxHistory": { "type": "object", "properties": { "employeeGuid": { "type": "string", "description": "The unique identifier for the Talent record, formatted as a UUID.", "format": "uuid", "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, "officeDivision": { "type": "string", "description": "The name of the division associated with the tax history data.", "example": "Midwest Division" }, "office": { "type": "string", "description": "The name of the office associated with the tax history data.", "example": "Eagan" }, "officeId": { "type": "integer", "description": "The identifier for the Office associated with the tax history data.", "format": "int32", "nullable": true, "example": 12 }, "year": { "type": "integer", "description": "The check date’s year for the tax history data.", "format": "int32", "example": 2025 }, "taxName": { "type": "string", "description": "The name of the tax.", "example": "Federal Income Tax" }, "taxCategory": { "$ref": "#/components/schemas/bo_prod__TaxCategory" }, "subjectGross": { "type": "number", "description": "The total amount of subject gross for this tax, grouped by talent, supplier, and year.", "format": "decimal", "example": 52000 }, "taxableGross": { "type": "number", "description": "The total amount of taxable gross for this tax, grouped by talent, supplier, and year.", "format": "decimal", "nullable": true, "example": 48000 }, "taxAmount": { "type": "number", "description": "The total amount of tax withheld for this tax, grouped by talent, supplier, and year.", "format": "decimal", "nullable": true, "example": 5760 } } }, "bo_prod__TaxCategory": { "type": "string", "example": "Employee Portion", "enum": [ "Employee Portion", "Employer Portion" ] }, "bo_prod__TaxMasterOption": { "type": "object", "properties": { "taxId": { "type": "integer", "description": "The unique identifier for the Tax.", "format": "int32", "example": 1 }, "taxName": { "type": "string", "description": "The name of the tax.", "example": "Federal Income Tax" }, "geocode": { "type": "string", "description": "A unique nine-digit number that corresponds to a specific locality.", "example": "270530590" } } }, "back_office__ArrayOfTalentW2": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__TalentW2" } }, "back_office__TalentW2": { "type": "object", "properties": { "w2Guid": { "type": "string", "description": "Globally unique identifier for Form W-2.", "format": "guid" }, "name": { "type": "string", "description": "The name of the employer (staffing supplier)." }, "taxYear": { "type": "integer", "description": "The taxation year the form is issued in.", "format": "int32" }, "wageTip": { "type": "number", "description": "Federal wages minus the withheld Federal income tax, Social Security tax, and Medicare tax.", "format": "decimal" }, "fedWages": { "type": "number", "description": "Federal taxable wages.", "format": "decimal" }, "fedTaxWithheld": { "type": "number", "description": "Total federal tax withheld.", "format": "decimal" }, "ssTaxWithheld": { "type": "number", "description": "Total social security tax withheld.", "format": "decimal" }, "medTaxWithheld": { "type": "number", "description": "Total Medicare tax withheld.", "format": "decimal" } }, "additionalProperties": false }, "front_office__ArrayOfTalentWorkHistory": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentWorkHistory" } }, "bo_prod__TaxCountyOption": { "type": "object", "properties": { "countyName": { "type": "string", "description": "The name of the county.", "example": "Montgomery" }, "stateCode": { "type": "string", "description": "The two-digit state code for the county.", "example": "MD" }, "countyGeocode": { "type": "string", "description": "The first five digits of a geocode representing the county.", "example": "24031" } } }, "bo_prod__TaxValidFilingStatusOption": { "type": "object", "properties": { "taxFilingStatusId": { "type": "integer", "description": "The unique identifier for the Tax Filing Status.", "format": "int32", "example": 1 }, "taxId": { "type": "integer", "description": "The unique identifier for the Tax record.", "format": "int32", "example": 1 }, "filingStatusName": { "type": "string", "description": "The name of the filing status.", "example": "Single" }, "defaultMaritalStatus": { "type": "integer", "description": "The default marital status associated with this filing status.", "format": "int32", "example": 1 } } }, "back_office__PagedResultsOfTransactionSummary": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/back_office__IPagedResultsOfTransactionSummary" }, { "required": [ "currentPage", "pageSize", "totalPages" ], "type": "object", "properties": { "pageSize": { "type": "integer", "description": "The number of items to be displayed on one page.", "format": "int32" }, "currentPage": { "type": "integer", "description": "The current page number.", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages.", "format": "int32" } }, "additionalProperties": false } ] }, "back_office__IPagedResultsOfTransactionSummary": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "The total number of items.", "format": "int32" }, "results": { "type": "array", "description": "The paged results.", "items": { "$ref": "#/components/schemas/back_office__TransactionSummary" } } }, "additionalProperties": false }, "back_office__TransactionSummary": { "required": [ "talentGuid", "transactionGuid" ], "type": "object", "properties": { "talentGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the talent, formatted as a GUID.", "format": "guid" }, "transactionGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the transaction, formatted as a UUID.", "format": "guid" }, "timeEntryBatchGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the time entry batch, formatted as a UUID.", "format": "guid" }, "supplierGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the staffing supplier, formatted as a UUID.", "format": "guid" }, "placementGuid": { "minLength": 1, "type": "string", "description": "The unique identifier for the placement (assignment), formatted as a UUID.", "format": "guid" }, "hoursWorked": { "type": "number", "description": "The total hours worked for this time entry transaction.", "format": "decimal" }, "wages": { "type": "number", "description": "The gross wages for this time entry transaction.", "format": "decimal" }, "weekWorkedDate": { "type": "string", "description": "The week worked date for this time entry transaction.", "format": "date-time" }, "accountingPeriodDate": { "type": "string", "description": "The accounting period date for this time entry transaction.", "format": "date-time" }, "payPeriod": { "$ref": "#/components/schemas/back_office__PayPeriod" }, "timeEntryItems": { "type": "array", "description": "The payment type line items for this time entry transaction.", "items": { "$ref": "#/components/schemas/back_office__TimeEntryPaymentItem" } } }, "additionalProperties": false }, "back_office__TimeEntryPaymentItem": { "type": "object", "properties": { "transactionTypeId": { "type": "integer", "description": "The identifier for the transaction type.", "format": "int32" }, "name": { "type": "string", "description": "The display name of the transaction type." }, "systemName": { "type": "string", "description": "The system name of the transaction type." }, "isTaxable": { "type": "boolean", "description": "An indication of whether this item is taxable." }, "payUnit": { "type": "number", "description": "The number of pay units for the time entry.", "format": "decimal" }, "payRate": { "type": "number", "description": "The rate of pay applied to the transaction.", "format": "decimal" }, "itemPay": { "type": "number", "description": "The total pay amount for this line item.", "format": "decimal" } } }, "front_office__ArrayOfUserGroup": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__UserGroup" } }, "front_office__UserGroup": { "type": "object", "properties": { "groupId": { "minimum": 1, "type": "integer", "description": "The identifier for the user group.", "format": "int32", "example": 284 }, "groupName": { "maxLength": 255, "type": "string", "description": "The name of the user group.", "example": "Administrators" } }, "additionalProperties": false }, "front_office__ArrayOfUserType": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__UserType" } }, "front_office__UserType": { "type": "object", "properties": { "userTypeId": { "minimum": 1, "type": "integer", "description": "The identifier for the user type.", "format": "int32", "example": 152 }, "userTypeName": { "maxLength": 255, "type": "string", "description": "The name of the user type.", "example": "Recruiter" } }, "additionalProperties": false }, "front_office__VmsJobBasicDto": { "type": "object", "properties": { "vmsJobId": { "type": "integer", "description": "The VMS job identifier.", "format": "int32" }, "vmsId": { "maxLength": 50, "type": "string", "description": "The VMS identifier (external system identifier).", "nullable": true }, "jobId": { "type": "integer", "description": "The Bold job identifier, if the VMS job has been actioned.", "format": "int32", "nullable": true }, "vmsCompany": { "maxLength": 255, "type": "string", "description": "The VMS company name.", "nullable": true }, "title": { "maxLength": 255, "type": "string", "description": "The job title.", "nullable": true }, "status": { "maxLength": 255, "type": "string", "description": "The job status name.", "nullable": true }, "positions": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The number of positions available.", "format": "int32" }, "startDate": { "minLength": 10, "type": "string", "description": "The job start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "endDate": { "minLength": 10, "type": "string", "description": "The job end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.", "format": "date-time" }, "vmsNotes": { "maxLength": 4000, "type": "string", "description": "Notes related to the VMS job.", "nullable": true }, "vmsName": { "maxLength": 100, "type": "string", "description": "The VMS name (e.g., \"SimpleVMS\", \"JobRobotix\").", "nullable": true }, "vendorId": { "type": "integer", "description": "The vendor identifier.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Details about the specified VMS job." }, "front_office__ArrayOfWorkerCompCode": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__WorkerCompCode" } }, "bo_prod__Department": { "title": "Department", "type": "object", "properties": { "companyExternalId": { "type": "string", "description": "The unique system-defined identifier for the Company.", "nullable": true, "example": "98765" }, "companyGuid": { "type": "string", "description": "The Back Office unique identifier for the Company, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "d4e5f6a7-8b9c-4d0e-1f2a-3b4c5d6e7f80" }, "departmentExternalId": { "type": "string", "description": "The unique system-defined identifier for the Company Department.", "nullable": true, "example": "54321" }, "departmentGuid": { "type": "string", "description": "The Back Office unique identifier for the Department, formatted as a UUID.", "format": "uuid", "nullable": true, "example": "e5f6a7b8-9c0d-4e1f-2a3b-4c5d6e7f8091" }, "departmentName": { "type": "string", "description": "The name of the company department.", "example": "Corporate" } } }, "front_office__ArrayOfAdobeESignDocument": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__AdobeESignDocument" } }, "back_office__TalentSupplementalBenefitsEligibility": { "required": [ "talentGuid", "transactionGuid" ], "type": "object", "properties": { "talentGuid": { "type": "string", "description": "Globally unique identifier for a talent.", "format": "guid" }, "transactionGuid": { "type": "string", "description": "Globally unique identifier for a transaction.", "format": "guid" }, "supplementalDeduction": { "$ref": "#/components/schemas/back_office__SupplementalDeduction" }, "supplementalPayment": { "$ref": "#/components/schemas/back_office__SupplementalPayment" } } }, "back_office__SupplementalDeduction": { "required": [ "deductionAmount", "transactionTypeId" ], "type": "object", "properties": { "transactionTypeId": { "type": "integer", "description": "The numeric identifier for a deduction transaction type.", "format": "int32" }, "deductionAmount": { "type": "number", "description": "The deduction amount.", "format": "decimal" } } }, "back_office__SupplementalPayment": { "required": [ "paymentAmount", "transactionTypeId" ], "type": "object", "properties": { "transactionTypeId": { "type": "integer", "description": "The numeric identifier for a payment transaction type.", "format": "int32" }, "paymentAmount": { "type": "number", "description": "The payment amount.", "format": "decimal" } } }, "front_office__ArrayOfTalentAllTags": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__TalentAllTags" } }, "front_office__ArrayOfDepartment": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__Department" } }, "front_office__ArrayOfCompany": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__Company" } }, "front_office__ArrayOfContact": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__Contact" } }, "front_office__ArrayOfTalent": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__Talent" } }, "front_office__ArrayOfTalentHomeOfficeEmployer": { "type": "array", "example": [ { "talentId": 123345, "employerId": 245 }, { "talentId": 456624, "employerId": 123 }, { "talentId": 789634, "employerId": 456 } ], "items": { "$ref": "#/components/schemas/front_office__TalentHomeOfficeEmployer" } }, "front_office__TalentHomeOfficeEmployer": { "type": "object", "properties": { "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 123345 }, "employerId": { "type": "integer", "description": "The identifier for the employer.", "format": "int32", "example": 245 } }, "additionalProperties": false }, "front_office__ArrayOfUserOffices": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__UserOffices" } }, "front_office__UserOffices": { "type": "object", "properties": { "userId": { "type": "integer", "description": "The identifier for the user.", "format": "int32" }, "officeIds": { "type": "array", "description": "A list of IDs for user offices.", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "front_office__ApiMultiWebApplicants": { "allOf": [ { "$ref": "#/components/schemas/front_office__ApiWebApplicants" }, { "type": "object", "properties": { "declineDate": { "type": "string", "description": "The date the web applicant was declined.", "format": "date-time" }, "applicantScore": { "type": "number", "description": "The score that shows how good of a match an applicant is for a job.", "format": "double" } }, "additionalProperties": false } ] }, "front_office__ArrayOfApiMultiWebApplicants": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__ApiMultiWebApplicants" } }, "front_office__PlacementSchedule": { "type": "object", "properties": { "placementId": { "type": "integer", "description": "The identifier for the placement.", "format": "int32", "example": 123456 }, "placementScheduleShifts": { "type": "array", "description": "The list of Placement Schedules Shifts.", "items": { "type": "object", "description": "front_office__PlacementScheduleShift (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } }, "additionalProperties": false }, "bo_prod__ArrayOfPatchOperations": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__Operation" } }, "bo_prod__Operation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/bo_prod__OperationBase" }, { "type": "object", "properties": { "value": { "type": "object" } }, "additionalProperties": false } ] }, "bo_prod__OperationBase": { "type": "object", "properties": { "path": { "type": "string", "description": "The location of the field to update or remove.", "example": "/deductionAmount" }, "op": { "type": "string", "description": "The operation type, such as 'replace' or 'remove'.", "example": "replace" }, "from": { "type": "string", "description": "Not used." }, "value": { "type": "string", "description": "The new value for 'replace' operations.", "example": "150.00" } }, "additionalProperties": false }, "back_office__UpdateConfigChoiceProperties": { "type": "object", "properties": { "configChoiceId": { "type": "integer", "description": "The unique identifier for the Config Choice to update.", "format": "int32" }, "choiceCode": { "type": "string", "description": "The Config Choice code." }, "choiceCodeDesc": { "type": "string", "description": "The Config Choice description." }, "configChoiceCategoryId": { "type": "integer", "description": "The category ID for the Config Choice property.", "format": "int32" } }, "additionalProperties": false }, "bo_prod__InvoiceArray": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__Invoice" } }, "bo_prod__InvoiceStylePatchRequest": { "type": "object", "properties": { "invoiceStyleGuid": { "type": "string", "description": "The unique identifier for the invoice style.", "format": "uuid", "nullable": true, "x-disabled-for-amazon-gateway": { "example": "d290f1ee-6c54-4b01-90e6-d701748f0851" } }, "invoiceGuids": { "type": "array", "items": { "type": "string", "description": "The unique identifier for the invoice.", "format": "uuid" }, "x-disabled-for-amazon-gateway": { "example": [ "a1f4c2e8-3b6d-4e9a-8c7f-1d2e3f4a5b6c" ] } } } }, "front_office__PartnerTaskStatusRequest": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string", "description": "The status to set for the partner task. Valid values are Completed, Rejected.", "example": "Completed" }, "notes": { "type": "string", "description": "Optional notes about the status update.", "nullable": true, "example": "Task completed successfully." } }, "additionalProperties": false }, "front_office__PartnerTaskStatusResponse": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "The identifier of the updated task.", "format": "int32", "example": 98765 }, "status": { "type": "string", "description": "The current status of the task.", "example": "Completed" } }, "additionalProperties": false }, "front_office__ServiceResult": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "error": { "type": "object" } }, "additionalProperties": false }, "front_office__ServiceResultOfTalent": { "allOf": [ { "$ref": "#/components/schemas/front_office__ServiceResult" }, { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "result": { "oneOf": [ { "$ref": "#/components/schemas/front_office__Talent" } ] } }, "additionalProperties": false } ] }, "back_office__ArrayOfPatchOperations": { "type": "array", "items": { "$ref": "#/components/schemas/back_office__Operation" } }, "back_office__OperationBase": { "type": "object", "properties": { "path": { "type": "string" }, "op": { "type": "string" }, "from": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "back_office__Operation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/back_office__OperationBase" }, { "type": "object", "properties": { "value": { "type": "object" } }, "additionalProperties": false } ] }, "bo_prod__UpdateCheckDeliveryRequest": { "type": "object", "properties": { "checkDeliveryCustomSetupOptionId": { "type": "integer", "description": "The unique identifier for the check delivery custom setup option.", "format": "int32", "x-disabled-for-amazon-gateway": { "example": 42 } } } }, "front_office__PipelineTalentStageUpdate": { "required": [ "jobActivityDate", "jobId", "pipelineStage", "stagedDate", "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the pipeline.", "format": "int32", "example": 15741 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 189482 }, "jobId": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 175529 }, "jobActivityId": { "type": "integer", "description": "The identifier for the job activity.", "format": "int32", "example": 7382 }, "jobActivityName": { "maxLength": 255, "type": "string", "description": "The name of the job activity/talent pipeline stage.", "example": "Pipelined" }, "stagedDate": { "type": "string", "description": "The date the talent was added to a pipeline stage. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "jobActivityDate": { "type": "string", "description": "The date of the job activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "declinedStageDate": { "type": "string", "description": "The date the talent declined the job. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "pipelineStage": { "maxLength": 255, "type": "string", "description": "The pipeline stage.", "example": "General" }, "creditTo": { "type": "integer", "description": "The identifier for the talent's representative or recruiter user record.", "format": "int32", "example": 24398 }, "message": { "type": "string", "description": "The response message returned to the API caller.", "example": "Please note that this applicant was previously pipelined, but then declined." } }, "additionalProperties": false }, "front_office__MODELd09243": { "required": [ "file" ], "type": "object", "properties": { "Id": { "type": "integer", "description": "The identifier for the talent document that will be generated by Avionté.", "format": "int32", "example": 28925 }, "TalentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 1328925 }, "FileName": { "maxLength": 255, "type": "string", "description": "The encrypted name of the file with extension that is generated by Avionté.", "example": "5jBlQJ8WSqJ67dNSMxLBDy2f.docx" }, "FileContent": { "type": "string", "description": "The content of the file to be uploaded. It will be populated using the content of the attached file. Valid file extensions are: 'txt', 'doc', 'docx', 'pdf', 'xls', 'xlsx', 'png', 'jpg', 'jpeg'.", "format": "binary" }, "DocumentTitle": { "maxLength": 500, "type": "string", "description": "The title of the document taken from the attached file.", "example": "John Doe Resume.docx" }, "DocumentDate": { "type": "string", "description": "The date when the document was uploaded. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "DocumentType": { "maxLength": 50, "type": "string", "description": "The type of the BOLD document.", "example": "Resume" }, "UploadedBy": { "type": "integer", "description": "The ID of the user uploading the document.", "format": "int32", "example": 123948 }, "IsPrivate": { "type": "boolean", "description": "An indication of whether the document is private or not.", "example": false }, "IsShared": { "type": "boolean", "description": "An indication of whether the document is shared or not.", "example": true }, "ExpiryDate": { "type": "string", "description": "The expiration date of the document. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "DocumentTypeId": { "type": "integer", "description": "The identifier for the BOLD document type.", "format": "int32", "example": 59245 }, "EmployerId": { "type": "integer", "description": "The identifier for the employer.", "format": "int32", "example": 234 }, "IsVisible": { "type": "boolean", "description": "An indication of whether the document is visible or not.", "example": true }, "DocumentContent": { "type": "string", "description": "The contents of the talent document as a Base-64 encoded string returned after file upload.", "format": "byte" }, "file": { "type": "string", "description": "The file to upload.", "format": "binary" } } }, "front_office__TalentDocumentFromBody": { "required": [ "documentContent", "documentTitle", "talentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the talent document.", "format": "int32", "example": 19424 }, "talentId": { "type": "integer", "description": "The identifier for the talent.", "format": "int32", "example": 138949 }, "fileName": { "maxLength": 255, "type": "string", "description": "The encrypted name of the file with extension that is generated by Avionté.", "example": "5jBlQJ8WSqJ67dNSMxLBDy2f.pdf" }, "documentTitle": { "maxLength": 500, "minLength": 1, "type": "string", "description": "The title of the document with extension. Valid file extensions are: 'txt', 'doc', 'docx', 'pdf', 'xls', 'xlsx', 'png', 'jpg', 'jpeg'.", "example": "John Doe Resume.docx" }, "documentDate": { "type": "string", "description": "The date when the document was uploaded. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "documentType": { "maxLength": 50, "type": "string", "description": "The type of the BOLD document.", "example": "Resume" }, "uploadedBy": { "type": "integer", "description": "The ID of the user who uploaded the document.", "format": "int32", "example": 183744 }, "isPrivate": { "type": "boolean", "description": "An indication of whether the document is private or not.", "example": false }, "isShared": { "type": "boolean", "description": "An indication of whether the document is shared or not.", "example": true }, "expiryDate": { "type": "string", "description": "The expiration date of the document. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.", "format": "date-time" }, "documentTypeId": { "type": "integer", "description": "The identifier for the BOLD document type.", "format": "int32", "example": 59245 }, "employerId": { "type": "integer", "description": "The identifier for the employer.", "format": "int32", "example": 3928 }, "isVisible": { "type": "boolean", "description": "An indication of whether the document is visible or not.", "example": true }, "documentContent": { "minLength": 1, "type": "string", "description": "The contents of talent document as a Base-64 Encoded string.", "format": "byte" } }, "additionalProperties": false }, "front_office__JobDocumentDTO": { "required": [ "documentDate", "documentTitle", "fileContent", "jobID", "uploadUserId" ], "type": "object", "properties": { "jobDocumentID": { "type": "integer", "description": "The identifier for the job document.", "format": "int32", "example": 123456 }, "jobID": { "type": "integer", "description": "The identifier for the job.", "format": "int32", "example": 1289822 }, "fileContent": { "type": "string", "description": "The content of the file to be uploaded. This should be a base64 encoded string." }, "documentTitle": { "maxLength": 255, "type": "string", "description": "The name of the document file.", "example": "Job Description.pdf" }, "documentType": { "maxLength": 50, "type": "string", "description": "The type of the document.", "example": "Job Description" }, "documentDate": { "type": "string", "description": "The date the document was uploaded. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.", "format": "date-time" }, "uploadedBy": { "maxLength": 50, "type": "string", "description": "The HCM ID of the user who uploaded the document.", "example": "JD28942" }, "uploadUserId": { "type": "integer", "description": "The identifier for the user who uploaded the document.", "format": "int32", "example": 12345 } }, "additionalProperties": false }, "front_office__StringSchema": { "type": "string" }, "front_office__TalentProfileImageDto": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/front_office__FileContentBase" }, { "type": "object", "additionalProperties": false } ] }, "front_office__FileContentBase": { "type": "object", "properties": { "fileName": { "type": "string" }, "fileContent": { "type": "string" } }, "additionalProperties": false }, "front_office__TimesheetDataDto": { "type": "object", "properties": { "week_ID": { "type": "integer", "description": "The weekly timesheet identifier.", "format": "int32" }, "cand_ID": { "type": "integer", "description": "The candidate/talent identifier.", "format": "int32" }, "req_hired_ID": { "type": "integer", "description": "The placement identifier.", "format": "int32" }, "req_ID": { "type": "string", "description": "The job requisition identifier." }, "weekStart": { "type": "string", "description": "The week start date.", "format": "date-time" }, "weekEnd": { "type": "string", "description": "The week ending date.", "format": "date-time" }, "mon": { "type": "number", "description": "Monday hours worked.", "format": "decimal" }, "tues": { "type": "number", "description": "Tuesday hours worked.", "format": "decimal" }, "wed": { "type": "number", "description": "Wednesday hours worked.", "format": "decimal" }, "thurs": { "type": "number", "description": "Thursday hours worked.", "format": "decimal" }, "fri": { "type": "number", "description": "Friday hours worked.", "format": "decimal" }, "sat": { "type": "number", "description": "Saturday hours worked.", "format": "decimal" }, "sun": { "type": "number", "description": "Sunday hours worked.", "format": "decimal" }, "weekTotal": { "type": "number", "description": "Total weekly hours.", "format": "decimal" }, "timesheetFormat": { "type": "string", "description": "Time capture format (DAILY_TIME or MOBILE_PUNCH)." }, "mondayBreaks": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BreakDto" } }, "tuesdayBreaks": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BreakDto" } }, "wednesdayBreaks": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BreakDto" } }, "thursdayBreaks": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BreakDto" } }, "fridayBreaks": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BreakDto" } }, "saturdayBreaks": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BreakDto" } }, "sundayBreaks": { "type": "array", "items": { "$ref": "#/components/schemas/front_office__BreakDto" } }, "mondayPunchIn": { "type": "string" }, "mondayPunchOut": { "type": "string" }, "tuesdayPunchIn": { "type": "string" }, "tuesdayPunchOut": { "type": "string" }, "wednesdayPunchIn": { "type": "string" }, "wednesdayPunchOut": { "type": "string" }, "thursdayPunchIn": { "type": "string" }, "thursdayPunchOut": { "type": "string" }, "fridayPunchIn": { "type": "string" }, "fridayPunchOut": { "type": "string" }, "saturdayPunchIn": { "type": "string" }, "saturdayPunchOut": { "type": "string" }, "sundayPunchIn": { "type": "string" }, "sundayPunchOut": { "type": "string" }, "submitted": { "type": "boolean", "description": "An indication of whether the timesheet has been submitted." }, "approved": { "type": "boolean", "description": "An indication of whether the timesheet has been approved." } }, "additionalProperties": false, "description": "Represents the timesheet data structure in the response following BOLD MyCompas patterns." }, "front_office__ValidationErrorDto": { "type": "object", "properties": { "field": { "type": "string", "description": "The field that failed validation." }, "message": { "type": "string", "description": "The validation error message." }, "value": { "type": "object", "description": "The value that failed validation." }, "day": { "type": "string", "description": "The day of week for date-specific errors." }, "severity": { "type": "string", "description": "The severity level of the validation error (Error, Warning, Info)." }, "details": { "type": "object", "description": "Additional details about the validation error." } }, "additionalProperties": false, "description": "Represents detailed validation error information." }, "front_office__DailyTimeSheetResponseDto": { "type": "object", "properties": { "success": { "type": "boolean", "description": "An indication of whether the operation was successful." }, "statusCode": { "description": "The status code for the operation result.", "oneOf": [ { "$ref": "#/components/schemas/front_office__ServiceResultStatusCode" } ] }, "data": { "description": "The timesheet data object (null on errors).", "oneOf": [ { "$ref": "#/components/schemas/front_office__TimesheetDataDto" } ] }, "error": { "type": "string", "description": "Primary error message (present on failures)." }, "messages": { "type": "array", "description": "Array of informational messages about the operation.", "items": { "type": "string" } }, "warnings": { "type": "array", "description": "Array of non-blocking warning messages for potential issues.", "items": { "type": "string" } }, "validationErrors": { "type": "array", "description": "Detailed validation error information with field-level context.", "items": { "$ref": "#/components/schemas/front_office__ValidationErrorDto" } }, "corrections": { "type": "array", "description": "Auto-corrections made by the system (e.g., time format corrections).", "items": { "type": "string" } }, "requestId": { "type": "string", "description": "Unique request identifier for error tracking and debugging." } }, "additionalProperties": false, "description": "Enhanced response model for daily timesheet operations.\nProvides detailed validation feedback, warnings, and auto-corrections." }, "front_office__BreakDto": { "type": "object", "properties": { "breakStart": { "type": "string", "description": "The break start time." }, "breakEnd": { "type": "string", "description": "The break end time." } }, "additionalProperties": false, "description": "Represents a break entry in the response." }, "front_office__DailyTimeSheetDto": { "required": [ "dayWorked", "placementId", "status" ], "type": "object", "properties": { "dayWorked": { "minLength": 1, "type": "string", "description": "The date for the time entry.\nThis should be just a date stamp. No time should be included.", "format": "date-time" }, "timeIn": { "type": "string", "description": "The start time of the day.\nFormat: 12-hour format (e.g., \"9:00 AM\").\nOptional for \"Saved\" status, required for \"Submitted\" and \"Approved\" statuses." }, "timeOut": { "type": "string", "description": "The end time of the day.\nFormat: 12-hour format (e.g., \"5:00 PM\").\nOptional for \"Saved\" status, required for \"Submitted\" and \"Approved\" statuses.\nSupports overnight shifts where TimeOut appears earlier than TimeIn." }, "breaks": { "type": "array", "description": "List of breaks for the day. Supports 0 to many breaks per day.\nEach break must have both BreakStart and BreakEnd times or both empty.\nBreak times must fall within the work shift period.", "items": { "$ref": "#/components/schemas/front_office__DailyBreakDto" } }, "placementId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The identifier for the placement. It allows the timesheet to be correlated with the talent to whom the time belongs.", "format": "int32" }, "status": { "minLength": 1, "pattern": "^(Saved|Submitted|Approved)$", "type": "string", "description": "The status of the timesheet. Accepted Values are: Saved, Submitted and Approved.\n- \"Saved\": Allows partial time entry (flexible validation)\n- \"Submitted\": Requires all times to be present and valid\n- \"Approved\": Requires all times to be present and valid" }, "useRounding": { "type": "boolean", "description": "Whether to round time values to the configured timesheet minute spread.\n- false: Validates that time values match the configured timesheet minute spread exactly\n- true: Automatically rounds time values to the nearest configured minute spread" } }, "additionalProperties": false, "description": "Represents a daily timesheet entry for single-day timesheet find-or-create operations.\nSupports daily hours and mobile punch time capture methods with multiple breaks per day." }, "front_office__ServiceResultStatusCode": { "type": "string", "description": "Status codes for service operation results.", "enum": [ "Success", "BadRequest", "NotFound", "Unauthorized", "Forbidden", "Conflict", "InternalServerError", "FeatureNotAvailable" ] }, "front_office__DailyBreakDto": { "type": "object", "properties": { "breakStart": { "type": "string", "description": "The break start time.\nFormat: 12-hour format (e.g., \"12:00 PM\").\nMust be provided if BreakEnd is provided (both required or both empty).\nMust fall within the work shift period." }, "breakEnd": { "type": "string", "description": "The break end time.\nFormat: 12-hour format (e.g., \"1:00 PM\").\nMust be provided if BreakStart is provided (both required or both empty).\nMust be after BreakStart time and within the work shift period." } }, "additionalProperties": false, "description": "Represents a single break entry within a daily timesheet.\nSupports multiple breaks per day with comprehensive validation." } }, "responses": { "front_office__400BadRequest": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "front_office__401Unauthorized": { "description": "Unauthorized" }, "front_office__403AccessDenied": { "description": "Access Denied" }, "front_office__404NotFound": { "description": "Not found", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "description": "Identifier of the entity not found (can be an integer or UUID)" } } } } } }, "front_office__405UnsupportedMethod": { "description": "Unsupported method" }, "front_office__406UnsupportedAccessHeader": { "description": "Unsupported format(s) indicated by Accept header" }, "front_office__409Conflict": { "description": "Operation could not be completed due to conflict." }, "front_office__415UnsupportedContentType": { "description": "Unsupported format(s) indicated by the Content-Type header" }, "front_office__429TooManyRequests": { "description": "Too many requests" }, "front_office__500InternalError": { "description": "An unexpected error occurred" }, "front_office__502BadGateway": { "description": "Service Unavailable" }, "front_office__504GatewayTimeout": { "description": "Gateway Timeout" }, "back_office__error400": { "description": "Bad Request", "content": {} }, "back_office__401Unauthorized": { "description": "Unauthorized" }, "back_office__403AccessDenied": { "description": "Access Denied" }, "back_office__404NotFound": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ServiceResultResourceNotFoundError" } } } }, "back_office__406UnsupportedAccessHeader": { "description": "Unsupported format(s) indicated by Accept header" }, "back_office__415UnsupportedContentType": { "description": "Unsupported format(s) indicated by the Content-Type header" }, "back_office__429TooManyRequests": { "description": "Too many requests" }, "back_office__500InternalError": { "description": "An unexpected error occurred" }, "back_office__502BadGateway": { "description": "Service Unavailable" }, "bo_prod__apiResultFailure400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ApiResultBadRequest" } } } }, "bo_prod__402BackOfficeSubscriptionRequired": { "description": "Additional subscription required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__402BackOfficeSubscriptionRequiredResponseBody" } } } }, "bo_prod__apiResultInsufficientPermissions403": { "description": "Access Denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ApiServiceResultError" } } } }, "bo_prod__apiResultNotFound404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ApiResultNotFound" } } } }, "bo_prod__405UnsupportedMethod": { "description": "Unsupported method" }, "bo_prod__apiResultDuplicate409": { "description": "Duplicate conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ApiServiceResultError" } } } }, "bo_prod__415UnsupportedContentType": { "description": "Unsupported format(s) indicated by the Content-Type header" }, "bo_prod__429TooManyRequests": { "description": "Too many requests" }, "bo_prod__500InternalError": { "description": "An unexpected error occurred" }, "bo_prod__502BadGateway": { "description": "Service Unavailable" }, "bo_prod__504GatewayTimeout": { "description": "Gateway Timeout" }, "bo_prod__TalentTaxDetailPostResponse": { "description": "Talent tax detail created successfully.", "headers": { "EmployeeGuid": { "description": "The unique identifier for the employee, formatted as a UUID.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__TaxDetail" }, "examples": { "Example 1": { "value": { "employeeGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "talentExternalId": 5567, "employeeTaxGuid": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c", "taxId": 1001, "taxName": "Federal Income Tax", "taxTypeId": 1, "taxType": "Federal", "vertexTaxId": 5001, "taxFilingStatusId": 1, "taxFilingStatusName": "Single", "exemptions": 1, "dependents": 0, "additionalWithholding": 25, "active": true, "isTaxExempt": false, "nrCert": false, "useDefaultExemptionAmount": true, "hasLockInLetter": false, "resident": true, "nonResident": false, "officeDivision": "Midwest Division", "federalW4Id": 3001, "hasMultipleJobs": false, "qualifyingChildren": 0, "otherDependents": 0, "totalDependents": 0, "otherIncome": 0, "deductions": 0, "firstWorkedDate": "2024-01-15T00:00:00Z", "usWithholdingType": "Citizen", "dateCompleted": "2024-01-10T00:00:00Z", "dateEntered": "2024-01-12T00:00:00Z", "stateCode": "MN", "revisionYear": 2026 } } } } } }, "bo_prod__CompanyBillingPreferencesGetResponse": { "description": "Company setup options and configuration related to billing.", "headers": { "CompanyGuid": { "description": "The unique identifier for the Company.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__CompanyBillingPreferences" }, "examples": { "Example 1": { "value": { "companyGuid": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22", "billingPeriod": "Unknown", "billingPeriodCycle": "1", "invoicePreferences": { "billToDepartmentGuid": "83db44f4-daee-496d-ba89-c3ed98de057d", "paymentTermsOptionId": 0, "invoiceStyleGuid": "e76d10eb-8ecc-4d0b-8c6c-173c133594ac", "separateInvoiceByOptionIds": [ 0 ], "groupInvoiceItemsByOptionIds": [ 0 ], "sortInvoiceItemsByOptionIds": [ 0 ], "displayInvoiceItemsByOptionIds": [ 0 ], "showDailyHours": false, "showTimeCard": false, "showWebTimeCard": false, "includePastInvoice": false, "maxInvoiceAmount": 1000.01, "printInvoice": false, "emailInvoiceTo": [ "user@example.com" ] }, "statementLetterPreferences": { "includeFinanceCharges": false, "financeChargePercent": 0, "financeChargeGracePeriod": 0, "increaseBalanceAmountDue": false, "autoEmailMonthlyStatements": false, "dayOfMonthToSendStatements": 0, "emailStatementTo": [ "user@example.com" ] } } } } } } }, "bo_prod__ExtraValuePostResponse": { "description": "Successfully created extra value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__ExtraValuePostResponse" }, "examples": { "Example 1": { "value": { "extraValues": [ { "extraValueId": 8801, "optionId": 501, "optionName": "T-Shirt Size", "category": "Onboarding", "value": "Large" } ], "errors": [] } } } } } }, "bo_prod__TalentTaxDetailResponse": { "description": "Successfully retrieved talent tax details.", "headers": { "EmployeeGuid": { "description": "The unique identifier for the employee, formatted as a UUID.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__TaxDetail" } }, "examples": { "Example 1": { "value": [ { "employeeGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "talentExternalId": 5567, "employeeTaxGuid": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c", "taxId": 1001, "taxName": "Federal Income Tax", "taxTypeId": 1, "taxType": "Federal", "vertexTaxId": 5001, "taxFilingStatusId": 1, "taxFilingStatusName": "Single", "exemptions": 1, "dependents": 0, "additionalWithholding": 25, "active": true, "isTaxExempt": false, "nrCert": false, "useDefaultExemptionAmount": true, "hasLockInLetter": false, "resident": true, "nonResident": false, "officeDivision": "Midwest Division", "federalW4Id": 3001, "hasMultipleJobs": false, "qualifyingChildren": 0, "otherDependents": 0, "totalDependents": 0, "otherIncome": 0, "deductions": 0, "firstWorkedDate": "2024-01-15T00:00:00Z", "usWithholdingType": "Citizen", "dateCompleted": "2024-01-10T00:00:00Z", "dateEntered": "2024-01-12T00:00:00Z", "stateCode": "MN", "revisionYear": 2026 } ] } } } } }, "bo_prod__TalentTaxCountyResponse": { "description": "Successfully retrieved tax county details.", "headers": { "EmployeeGuid": { "description": "The unique identifier for the employee, formatted as a UUID.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__TaxCountyDetailResponse" }, "examples": { "Example 1": { "value": { "employeeTaxCountyId": 7788, "year": 2026, "residentCountyGeocode": "27053", "worksiteCountyGeocode": "27053", "residentCountyName": "Hennepin", "worksiteCountyName": "Hennepin" } } } } } }, "bo_prod__TalentAccrualPlanDateTypeOptionItemsResponse": { "description": "Successfully retrieved accrual plan date type option items.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__AccrualDateTypeOption" } }, "examples": { "Example 1": { "value": [ "CalendarDate", "AnniversaryDate", "Unknown" ] } } } } }, "bo_prod__TalentAccrualPlanRateTypeOptionItemsResponse": { "description": "Successfully retrieved accrual plan rate type option items.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__AccrualRateTypeOption" } }, "examples": { "Example 1": { "value": [ "PerHour", "PerPayPeriod", "Unknown" ] } } } } }, "bo_prod__403AccessDenied": { "description": "Access Denied" }, "bo_prod__HoursHistoryDetailPostResponse": { "description": "Hours history detail reponse containing records for each pay type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__HoursHistoryDetail" }, "examples": { "Example 1": { "value": { "hoursDetails": [ { "transactionGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "transactionEntryItemGuid": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c", "transactionType": "Regular", "payUnit": 40, "billUnit": 40, "payRate": 20, "billRate": 30, "costRate": 2.5, "itemPay": 800, "itemBill": 1200, "itemCost": 100, "itemText": "Regular hours for week ending 2026-05-03" } ] } } } } } }, "bo_prod__AdminCustomSetupOptionResponse": { "description": "Successfully retrieved custom setup options by category.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__CustomSetupOption" } }, "examples": { "Example 1": { "value": [ { "optionId": 501, "optionName": "Overpayment Recovery", "categoryId": 30, "categoryName": "AdjustmentSetup", "branchGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "isVisible": true, "customSetupOptionProperties": [ { "propertyName": "RecoveryMethod", "propertyDescription": "How the overpayment adjustment is recovered", "defaultValue": "NextPaycheck", "propertyValue": "NextPaycheck" } ] } ] } } } } }, "bo_prod__AdminBurdenResponse": { "description": "Successfully retrieved employer burden rates with burden factor.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__BurdenRate" } }, "examples": { "Example 1": { "value": [ { "burdenGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "burdenRateGuid": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c", "burdenName": "General Liability", "category": "Insurance", "calcType": "TotalSales", "rate": 1.5, "burdenFactor": 1, "rateStartDate": "2026-01-01T00:00:00Z", "rateEndDate": "2026-12-31T00:00:00Z" } ] } } } } }, "bo_prod__AdminEmployerTaxResponse": { "description": "Successfully retrieved Employer Tax Rate setup.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__EmployerTaxRate" }, "examples": { "Example 1": { "value": { "federalEmployerTaxRate": 6.2, "stateEmployerTaxRates": [ { "taxId": 2001, "taxRateGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "stateCode": "MN", "taxName": "MN SUTA", "taxRate": 2.5, "taxType": "SUTA", "startDate": "2026-01-01T00:00:00Z", "endDate": "2026-12-31T00:00:00Z" } ] } } } } } }, "bo_prod__AdminWorkerCompResponse": { "description": "Successfully retrieved Worker Comp Code setup.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__WcCodeRate" } }, "examples": { "Example 1": { "value": [ { "configWcCodeId": 433, "configWcCodeRateGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "workerCompCode": "8810", "description": "Clerical Office Employees", "state": "MN", "costPercent": 1.25, "ratePercent": 2.75, "wcEePercent": 0.5, "wcErPercent": 1.1, "startDate": "2026-01-01T00:00:00Z", "endDate": "2026-12-31T00:00:00Z" } ] } } } } }, "bo_prod__ExtraValueGetResponse": { "description": "Successfully retrieved extra values.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__ExtraValueGetResponse" } }, "examples": { "Example 1": { "value": [ { "extraValueId": 8801, "optionId": 501, "optionName": "T-Shirt Size", "category": "Onboarding", "value": "Large", "extraValueProperty": [ { "propertyName": "Size", "propertyDescription": "Available sizes", "defaultValue": "Medium", "propertyValue": "Large" } ] } ] } } } } }, "bo_prod__TalentResponse": { "description": "Successfully retrieved the requested talent record.", "headers": { "EmployeeGuid": { "description": "The unique identifier for the Talent.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__Talent" }, "examples": { "Example 1": { "value": { "talentGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "branchGuid": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c", "backOfficeEmployeeId": 5567, "firstName": "Jane", "middleName": "A", "lastName": "Smith", "residentAddress": { "addressGuid": "83db44f4-daee-496d-ba89-c3ed98de057d", "street1": "123 Main St", "street2": "Apt 4", "city": "Minneapolis", "postalCode": "55401", "state": "MN", "country": "US" }, "taxIdNumber": "111-11-1111", "dateOfBirth": "1990-05-05T00:00:00Z", "mobilePhone": "555-123-4567", "emailAddress": "jane.smith@example.com", "gender": "F", "checkDeliveryOptionId": 1 } } } } } }, "bo_prod__TalentAccrualPlanOptionItemsResponse": { "description": "Successfully retrieved talent accrual plan option items.", "headers": { "EmployeeGuid": { "description": "The unique identifier for the Talent.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__AccrualPlanOption" } }, "examples": { "Example 1": { "value": [ { "configAccrualPlanGuid": "83db44f4-daee-496d-ba89-c3ed98de057d", "staffingSupplierGuid": "221f6433-1a3e-ea11-9422-005056962b79", "accrualPlan": "Standard PTO", "description": "Standard paid time off plan", "rate": 0.0385, "accrualRateTypeOption": "PerHour", "payPeriodLimit": 8, "yearlyLimit": 80, "maximumAccrualBalance": 120, "initialBalance": 0, "unlimitedCarryover": false, "allowedCarryover": 40, "accrualDateTypeOption": "CalendarDate", "active": true, "processingMethod": "Accrual", "accrualPayTypeOption": "IncludeInWeeklyPay", "autoInsert": true, "suppressionDays": 90 } ] } } } } }, "back_office__talentMultiQuery200Response": { "description": "OK", "headers": { "RequestId": { "$ref": "#/components/headers/back_office__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentMultiQuerySuccess" } } } }, "back_office__talentMultiQuery207Response": { "description": "Partial Success", "headers": { "RequestId": { "$ref": "#/components/headers/back_office__RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__TalentMultiQuery" } } } }, "bo_prod__TalentTaxHistoryResponse": { "description": "Successfully retrieved talent tax history.", "headers": { "EmployeeGuid": { "description": "The unique identifier for the Talent.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__TaxHistory" } }, "examples": { "Example 1": { "value": [ { "employeeGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "officeDivision": "Midwest Division", "office": "Minneapolis Office", "officeId": 12, "year": 2026, "taxName": "Federal Income Tax", "taxCategory": "Employee Portion", "subjectGross": 45000, "taxableGross": 42000, "taxAmount": 5400 } ] } } } } }, "bo_prod__TaxOptionsTaxResponse": { "description": "Successfully retrieved tax master options.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__TaxMasterOption" } }, "examples": { "Example 1": { "value": [ { "taxId": 1001, "taxName": "Federal Income Tax", "geocode": "000000000" }, { "taxId": 1002, "taxName": "MN State Income Tax", "geocode": "270000000" } ] } } } } }, "bo_prod__TaxCountyOptionsResponse": { "description": "Successfully retrieved tax county options.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__TaxCountyOption" } }, "examples": { "Example 1": { "value": [ { "countyName": "Hennepin", "stateCode": "MN", "countyGeocode": "27053" }, { "countyName": "Ramsey", "stateCode": "MN", "countyGeocode": "27123" } ] } } } } }, "bo_prod__TaxFilingStatusOptionsResponse": { "description": "Successfully retrieved tax filing status options.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__TaxValidFilingStatusOption" } }, "examples": { "Example 1": { "value": [ { "taxFilingStatusId": 1, "taxId": 1001, "filingStatusName": "Single", "defaultMaritalStatus": 0 }, { "taxFilingStatusId": 2, "taxId": 1001, "filingStatusName": "Married", "defaultMaritalStatus": 1 } ] } } } } }, "bo_prod__InvoiceToDeparmentGetResponse": { "description": "Returns a list of company departments that can be used to specify where billing should be invoiced to.", "content": { "application/json": { "schema": { "type": "array", "properties": { "id": { "type": "string", "description": "The identifier for the department." } }, "items": { "$ref": "#/components/schemas/bo_prod__Department" } }, "examples": { "Example 1": { "value": [ { "companyExternalId": "1001", "companyGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "departmentExternalId": "2001", "departmentGuid": "e924a970-3b6b-4c9f-b9e3-37d47cb0f40c", "departmentName": "Accounts Payable" }, { "companyExternalId": "1001", "companyGuid": "0f8fad5b-d9cb-469f-a165-70867728950e", "departmentExternalId": "2002", "departmentGuid": "83db44f4-daee-496d-ba89-c3ed98de057d", "departmentName": "Billing" } ] } } } } }, "bo_prod__ExtraValuePatchResponse": { "description": "Successfully modified extra value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__Extra" }, "examples": { "Example 1": { "value": { "extraValueId": 8801, "optionId": 501, "optionName": "T-Shirt Size", "category": "Onboarding", "value": "Large" } } } } } } }, "securitySchemes": { "front_office__api_key": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "front_office__bearerTokenAuth": { "type": "http", "description": "Contains the caller's access token, in the form \"Bearer {token}\", without quotes.", "scheme": "bearer", "bearerFormat": "JWT" }, "back_office__security_key_header": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "back_office__bearerHttpAuthentication": { "type": "http", "description": "Contains the caller access token, in the form \"Bearer {token}\", without quotes.", "scheme": "bearer", "bearerFormat": "JWT" }, "authorize__api_key": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "bo_prod__gatewayApiKey": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "bo_prod__bearerTokenAuth": { "type": "http", "description": "Contains the caller's access token, in the form \"Bearer {token}\", without quotes.", "scheme": "bearer", "bearerFormat": "JWT" }, "events__api_key": { "type": "apiKey", "name": "x-api-key", "in": "header" } }, "requestBodies": { "bo_prod__CreateAdditionalTaxPostBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__AdditionalTax" }, "examples": { "Example 1": { "value": { "taxId": 12, "taxFilingStatusId": 3, "dependents": 2, "exemptions": 1, "AdditionalWithholding": 50, "hasMultipleJobs": false, "qualifyingChildren": 4000, "otherDependents": 500, "otherIncome": 0, "deductions": 0 } } } } } }, "bo_prod__CompanyBillingPreferencesBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__CompanyBillingPreferences" }, "examples": { "Example 1": { "value": { "companyGuid": "0f7b20f9-05f0-4ca5-9877-5b8df2eb2a22", "billingPeriod": "Unknown", "billingPeriodCycle": "1", "invoicePreferences": { "billToDepartmentGuid": "83db44f4-daee-496d-ba89-c3ed98de057d", "paymentTermsOptionId": 0, "invoiceStyleGuid": "e76d10eb-8ecc-4d0b-8c6c-173c133594ac", "separateInvoiceByOptionIds": [ 0 ], "groupInvoiceItemsByOptionIds": [ 0 ], "sortInvoiceItemsByOptionIds": [ 0 ], "displayInvoiceItemsByOptionIds": [ 0 ], "showDailyHours": false, "showTimeCard": false, "showWebTimeCard": false, "includePastInvoice": false, "maxInvoiceAmount": 1000.01, "printInvoice": false, "emailInvoiceTo": [ "user@example.com" ] }, "statementLetterPreferences": { "includeFinanceCharges": false, "financeChargePercent": 0, "financeChargeGracePeriod": 0, "increaseBalanceAmountDue": false, "autoEmailMonthlyStatements": false, "dayOfMonthToSendStatements": 0, "emailStatementTo": [ "user@example.com" ] } } } } } } }, "bo_prod__CreateExtraValueRequestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__ExtraValuePostBody" } }, "examples": { "Example 1": { "value": [ { "customSetupOptionId": 101, "extraValueOptionValue": "Night Shift" }, { "customSetupOptionId": 102, "extraValueOptionValue": "Union Member" } ] } } } } }, "bo_prod__TalentAccrualPlanManualEntryPostBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__TalentAccrualManualEntryRequest" }, "examples": { "Example 1": { "value": { "talentAccrualGuid": "c4e5d6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f", "accruedUnit": 8, "effectiveDate": "2026-06-15T00:00:00", "excludeFromLimitCalculation": false, "note": "Manual PTO adjustment for approved leave." } } } } } }, "bo_prod__CreateTaxCountyRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__TaxCountyDetailRequest" }, "examples": { "Example 1": { "value": { "employeeTaxCountyId": 5001, "year": 2026, "residentCountyGeocode": "27053", "worksiteCountyGeocode": "27053" } } } } } }, "bo_prod__arrayOfGuids": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bo_prod__backofficeIdentifierUuid" } } } }, "required": true }, "back_office__multiQueryRequest": { "description": "An array of unique identifiers to request data for.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/back_office__ArrayOfGuids" } } }, "required": true }, "bo_prod__InvoiceStylePatchBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__InvoiceStylePatchRequest" }, "examples": { "Example 1": { "value": { "invoiceStyleGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851", "invoiceGuids": [ "a1f4c2e8-3b6d-4e9a-8c7f-1d2e3f4a5b6d" ] } } } } } }, "bo_prod__UpdateCheckDeliveryPutBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bo_prod__UpdateCheckDeliveryRequest" }, "examples": { "Example 1": { "value": { "checkDeliveryCustomSetupOptionId": 42 } } } } } } }, "headers": { "bo_prod__RequestId": { "description": "The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/bo_prod__RequestId" } }, "back_office__RequestId": { "description": "The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.", "schema": { "type": "string", "format": "uuid" }, "example": "D28A8AEF-43A0-4FA3-8BFD-A237A5C2760D" } } }, "tags": [ { "name": "Companies" }, { "name": "Contacts" }, { "name": "Talent", "description": "Endpoints to manage a talent record, sometimes called an applicant or employee." }, { "name": "Jobs" }, { "name": "Placements" }, { "name": "Departments" }, { "name": "TalentBenefits" }, { "name": "Certificates" }, { "name": "Billing Preferences", "description": "Configure company billing and invoice preferences." }, { "name": "Users" }, { "name": "Mapping" }, { "name": "Web Applicants" }, { "name": "Billing", "description": "Setup options for billing and invoicing." }, { "name": "Branches" }, { "name": "Branch" }, { "name": "Company", "description": "Setup options for configuring a company record." }, { "name": "Employment Types" }, { "name": "Reference" }, { "name": "Partner References" }, { "name": "Payroll", "description": "Setup options for payroll." }, { "name": "Paychecks" }, { "name": "Placement" }, { "name": "Supplier", "description": "Endpoints to manage supplier records, sometimes called a division or employer." }, { "name": "Reports" } ], "x-crawl-source": { "connector": "avionte", "discoveryUrl": "https://developer.avionte.com/reference/", "excludedServerPrefixes": [ "/talent" ], "generatedAt": "2026-09-12T15:46:23.410Z", "discoveredPages": 352, "processedPages": 346, "skippedPages": [ "https://developer.avionte.com/reference/accrual.md :: No JSON OpenAPI block found in https://developer.avionte.com/reference/accrual.md", "https://developer.avionte.com/reference/billing-preferences.md :: No JSON OpenAPI block found in https://developer.avionte.com/reference/billing-preferences.md", "https://developer.avionte.com/reference/company-1.md :: No JSON OpenAPI block found in https://developer.avionte.com/reference/company-1.md", "https://developer.avionte.com/reference/company-2.md :: No JSON OpenAPI block found in https://developer.avionte.com/reference/company-2.md", "https://developer.avionte.com/reference/export.md :: No JSON OpenAPI block found in https://developer.avionte.com/reference/export.md", "https://developer.avionte.com/reference/talent.md :: No JSON OpenAPI block found in https://developer.avionte.com/reference/talent.md", "https://developer.avionte.com/reference/createmessage.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/createtalent-1.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/deletetalenteducation.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/deleteworkhistory.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/gethealth.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/gettalentbyids.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/gettalentbypage.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/gettalenteducation.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/gettalenteducationall.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/gettalentidsbymodifieddate.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/gettalentquestions.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/getworkhistory.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/getworkhistoryall.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/postchoiceresult.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/posttalenteducation.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/posttalentquestions.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/postworkhistory.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/processfederalw42020.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/processformw4.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/puttalenteducation.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/putworkhistory.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/savedirectdepositaccounts.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/settaxcredit.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/updatetalent-1.md :: excluded server prefix /talent", "https://developer.avionte.com/reference/uploaddocument.md :: excluded server prefix /talent" ], "failures": [], "conflicts": [], "serverPrefixes": [ "/authorize", "/back-office", "/bo-prod", "/events", "/front-office" ] } }