Added

Oyster API updates - 29 October 2026

about 3 hours ago

v0.1 Credit Notes API updates, v0.1 Invoices API updates, v1 Benefits API updates, v1 Calculators API release, v1 Contract Changes API updates, v1 Credit Notes API updates, v1 Employments API updates, v1 Invoices API updates

v0.1 API updates

v0.1 Credit Notes API updates

Release includes: Retrieve credit note breakdown; new credit note type value MANUAL_OYSTER_FEES_REFUND; optional field files.breakdown (XLSX) in Retrieve a credit note

v0.1 Invoices API updates

Release includes: optional object customer in Retrieve invoice breakdown

v1 API updates

v1 Benefits API updates

Release includes: Retrieve an engagement's benefits, Provision benefits for an engagement, Retrieve a country's available benefits offerings

v1 Calculators API release

Release includes: Calculate cost of employment

v1 Contract Changes API updates

Release includes: fields agreementAmendment and oysterServiceAgreementAmendment (null when no document) in Retrieve all contract changes and Retrieve an individual contract change request

v1 Credit Notes API updates

Release includes: new credit note type value MANUAL_OYSTER_FEES_REFUND; optional field files.breakdown (XLSX) in Retrieve a credit note

v1 Employments API updates

Release includes: Retrieve service agreement, Accept service agreement

v1 Invoices API updates

Release includes: optional object customer in Retrieve invoice breakdown