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 response: title

v0.1 Contract Changes API updates

• Update includes additional objects in Retrieve all contract changes and Retrieve an individual contract change response: agreementAmendment, oysterServiceAgreementAmendment
• Update includes additional object arrays in Create request: allowancesToAdd, bonusesToAdd, allowancesToRemove, allowancesToRemove

v0.1 Credit note API updates

• Release includes: Retrieve a Credit note, Retrieve credit notes rulesets for source types, Retrieve credit notes rulesets for source statuses

v0.1 Employments API updates

• Update replaces the defaultSigner object with a new signer object in the Update employment endpoint

v0.1 Engagements API updates

• Release includes: Retrieve allowances for engagement, Retrieve bonuses for engagement

v0.1 Invoicing API updates

• Release includes: Approve invoice, Dispute invoice, Retrieve invoices rulesets for source types, Retrieve invoices rulesets for source statuses

v1 API

v1 Bank Accounts API updates

• Update includes additional field in Retrieve bank account rulesets response: title

v1 Employments API updates

• Release includes: Update employment

v1 Payroll API updates

• Update includes removal of include_reports parameter in the Retrieve all payroll endpoint

Webhooks

Payroll webhooks release

• Release includes: payroll.contractor_fees_invoice_generated, payroll.contractor_fees_invoicing_initialized, payroll.pre_funding_invoice_created, payroll.settlement_invoice_created