search
AG5.comSupportRequest a demo

EmploymentContracts

Operations for EmploymentContracts

hashtag
List employmentContracts

get

List employmentContracts

Filter Syntax:

  • Filters use exact match only

  • Multiple filters are combined with AND logic

  • Filterable fields: contractTypeID, employeeID

  • Example: ?contractTypeID=123e4567-e89b-12d3-a456-426614174000&employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Query parameters
contractTypeIDstringOptional

Filter by contractTypeID (exact match)

employeeIDstringOptional

Filter by employeeID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10
cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses
chevron-right
200

Successful response

application/json
get
/employmentContracts

hashtag
Get EmploymentContract

get

Get a single EmploymentContract by ID

Authorizations
Path parameters
idstringRequired

EmploymentContract ID

Responses
chevron-right
200

Successful response

application/json
activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)
contractTypeIDstring · uuidOptional
createdAtstring · date-timeRequired
employeeIDstring · uuidRequired
idstring · uuidRequired
lastModifiedAtstring · date-timeRequired
repositoryIDstring · uuidRequired
get
/employmentContracts/{id}

hashtag
List EmploymentContract creation proposals

get

List all createEmploymentContracts proposals. These are proposed changes to create new EmploymentContract records that may be automatically approved or require manual approval depending on system configuration.

Filter Syntax:

  • Filters use exact match only

  • Multiple filters are combined with AND logic

  • Filterable fields: contractTypeID, employeeID

  • Example: ?contractTypeID=123e4567-e89b-12d3-a456-426614174000&employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Query parameters
contractTypeIDstringOptional

Filter by contractTypeID (exact match)

employeeIDstringOptional

Filter by employeeID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10
cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses
chevron-right
200

Successful response

application/json
get
/createEmploymentContracts

hashtag
Propose creation of EmploymentContracts

post

Create new proposals to add EmploymentContract records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations
Bodyobject[]
activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)
contractTypeIDstring · uuidOptional
employeeIDstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
post
/createEmploymentContracts

hashtag
Get EmploymentContract creation proposal

get

Get details of a specific EmploymentContract creation proposal by ID

Authorizations
Path parameters
idstringRequired

CreateEmploymentContractProposal ID

Responses
chevron-right
200

Successful response

application/json
activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)
contractTypeIDstring · uuidOptional
employeeIDstring · uuidRequired
isProposalExecutionFailedbooleanRead-onlyRequired
isProposalResolvedbooleanRead-onlyRequiredExample: false
proposalExecutionErrorTextstringRead-onlyOptional
repositoryIDstring · uuidRequired
requestIDstring · uuidRead-onlyRequired
subjectIDstring · uuidRead-onlyRequired
get
/createEmploymentContracts/{id}

hashtag
List EmploymentContract deletion proposals

get

List all deleteEmploymentContracts proposals. These are proposed changes to delete EmploymentContract records that may be automatically approved or require manual approval depending on system configuration.

Authorizations
Query parameters
limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10
cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses
chevron-right
200

Successful response

application/json
get
/deleteEmploymentContracts

hashtag
Propose deletion of EmploymentContracts

post

Create new proposals to delete EmploymentContract records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations
Bodyobject[]
idstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
post
/deleteEmploymentContracts

hashtag
Get EmploymentContract deletion proposal

get

Get details of a specific EmploymentContract deletion proposal by ID

Authorizations
Path parameters
idstringRequired

DeleteEmploymentContractProposal ID

Responses
chevron-right
200

Successful response

application/json
idstring · uuidRequired
isProposalExecutionFailedbooleanRead-onlyRequired
isProposalResolvedbooleanRead-onlyRequiredExample: false
proposalExecutionErrorTextstringRead-onlyOptional
repositoryIDstring · uuidRequired
requestIDstring · uuidRead-onlyRequired
get
/deleteEmploymentContracts/{id}

hashtag
List EmploymentContract update proposals

get

List all updateEmploymentContracts proposals. These are proposed changes to update existing EmploymentContract records that may be automatically approved or require manual approval depending on system configuration.

Filter Syntax:

  • Filters use exact match only

  • Multiple filters are combined with AND logic

  • Filterable fields: contractTypeID, employeeID

  • Example: ?contractTypeID=123e4567-e89b-12d3-a456-426614174000&employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Query parameters
contractTypeIDstringOptional

Filter by contractTypeID (exact match)

employeeIDstringOptional

Filter by employeeID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10
cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses
chevron-right
200

Successful response

application/json
get
/updateEmploymentContracts

hashtag
Propose update of EmploymentContracts

post

Create new proposals to update EmploymentContract records. All fields are optional - omitted fields will not be changed. Only include fields you want to update. Setting a field to null will clear its value (where applicable). The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations
Bodyobject[]
activePeriodstringOptional

Date range in PostgreSQL format [start,end) (omit to keep current value)

Example: [2023-01-01,2023-12-31)
contractTypeIDstring · uuidOptional

Omit this field to keep current value

employeeIDstring · uuidOptional

Omit this field to keep current value

idstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
post
/updateEmploymentContracts

hashtag
Get EmploymentContract update proposal

get

Get details of a specific EmploymentContract update proposal by ID

Authorizations
Path parameters
idstringRequired

UpdateEmploymentContractProposal ID

Responses
chevron-right
200

Successful response

application/json
activePeriodstringOptional

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)
contractTypeIDstring · uuidOptional
employeeIDstring · uuidOptional
idstring · uuidRequired
isProposalExecutionFailedbooleanRead-onlyRequired
isProposalResolvedbooleanRead-onlyRequiredExample: false
proposalExecutionErrorTextstringRead-onlyOptional
repositoryIDstring · uuidRequired
requestIDstring · uuidRead-onlyRequired
get
/updateEmploymentContracts/{id}
PreviousEmploymentContractTypesNextEmploymentRelationTypes

Last updated

Was this helpful?