---
agentTools:
  projectIndex: https://docs.oysterhr.com/v0.1/llms.txt
---

# Oyster API updates - 7 July 2025

v0.1 Bank Accounts API updates, v0.1 Contract Changes API updates, v0.1 Credit note API updates, v0.1 Employments API updates, v0.1 Engagements API updates, v0.1 Invoicing API updates, v1 Bank Accounts updates, v1 Employments API updates, v1 Payroll API updates, Payroll webhooks release

## v0.1 API

### v0.1 Bank Accounts API updates

* Update includes additional field in [Retrieve bank account rulesets](https://docs.oysterhr.com/v0.1/update/reference/get_v0-1-bank-accounts-rulesets#/) response: `title`

### v0.1 Contract Changes API updates

* Update includes additional objects in [Retrieve all contract changes](https://docs.oysterhr.com/v0.1/reference/get_v0-1-contract-changes#/) and [Retrieve an individual contract change](https://docs.oysterhr.com/v0.1/reference/get_v0-1-contract-changes-id#/) response: `agreementAmendment`, `oysterServiceAgreementAmendment`
* Update includes additional object arrays in [Create request](https://docs.oysterhr.com/v0.1/reference/post_v0-1-contract-changes#/): `allowancesToAdd`, `bonusesToAdd`, `allowancesToRemove`, `allowancesToRemove`

### v0.1 Credit note API updates

* Release includes: [Retrieve a Credit note](https://docs.oysterhr.com/v0.1/reference/get_v0-1-credit-notes-identifier), [Retrieve credit notes rulesets for source types](https://docs.oysterhr.com/v0.1/reference/get_v0-1-credit-notes-sources-types), [Retrieve credit notes rulesets for source statuses](https://docs.oysterhr.com/v0.1/reference/get_v0-1-credit-notes-sources-statuses)

### v0.1 Employments API updates

* Update replaces the `defaultSigner` object with a new `signer` object in the [Update employment](https://docs.oysterhr.com/v0.1/reference/patch_v0-1-hiring-employments-id#/) endpoint

### v0.1 Engagements API updates

* Release includes: [Retrieve allowances for engagement](https://docs.oysterhr.com/v0.1/reference/get_v0-1-engagements-id-allowances#/), [Retrieve bonuses for engagement](https://docs.oysterhr.com/v0.1/reference/get_v0-1-engagements-id-bonuses#/)

### v0.1 Invoicing API updates

* Release includes: [Approve invoice](https://docs.oysterhr.com/v0.1/reference/post_v0-1-invoices-identifier-approve), [Dispute invoice](https://docs.oysterhr.com/v0.1/reference/post_v0-1-invoices-identifier-dispute), [Retrieve invoices rulesets for source types](https://docs.oysterhr.com/v0.1/reference/get_v0-1-invoices-sources-types), [Retrieve invoices rulesets for source statuses](https://docs.oysterhr.com/v0.1/reference/get_v0-1-invoices-sources-statuses)

<br />

## v1 API

### v1 Bank Accounts API updates

* Update includes additional field in [Retrieve bank account rulesets](https://docs.oysterhr.com/reference/get_v1-bank-accounts-rulesets#/) response: `title`

### v1 Employments API updates

* Release includes: [Update employment](https://docs.oysterhr.com/reference/patch_v1-hiring-employments-id#/)

### v1 Payroll API updates

* Update includes removal of `include_reports` parameter in the [Retrieve all payroll](https://docs.oysterhr.com/reference/get_v1-payroll#/) endpoint

<br />

## Webhooks

### Payroll webhooks release

* Release includes: [payroll.contractor\_fees\_invoice\_generated](https://docs.oysterhr.com/reference/post_payroll-contractor-fees-invoice-generated#/), [payroll.contractor\_fees\_invoicing\_initialized](https://docs.oysterhr.com/reference/post_payroll-contractor-fees-invoicing-initialized#/), [payroll.pre\_funding\_invoice\_created](https://docs.oysterhr.com/reference/post_payroll-pre-funding-invoice-created#/), [payroll.settlement\_invoice\_created](https://docs.oysterhr.com/reference/post_payroll-settlement-invoice-created#/)