# Changelog

The API version numbering scheme consists of four components:

- *Major* - All versions that share a Major component retain backward compatibility 
even as new functionality is introduced between minor versions.
- *Minor* - Minor versions introduce new functionality such as new optional parameters 
or entirely new endpoints.
- *Sub-Minor* - Sub-Minor versions introduce small improvements such as better 
performance or bug fixes that generally do not require documentation changes.
- *Doc* - Doc versions indicate documentation updates. If two versions differ only by 
doc component, there was no change to the server code between them.


br
**Recent changes to the Fetch API are listed below by version.**

### 3.26.2.2

- This version was released on 2025-10/15.
- Documented how the "billed" property of certain accounting response payloads maps to differently named fields in specific versions of the YDInv.exe UI.
- For GET /receipts endpoint, improve documentation for "Filter" query parameter options and add examples.


### 3.26.2.1

- This version was released on 2025-10/10.
- Support case-insensitive parsing of the Authorization header:
  - All endpoints now accept both Authorization: `Bearer` {token} and Authorization: `bearer` {token}.
- Sessions endpoints now protect against accidental changes:
  - Once a Count Session is marked Finalized, it is locked. You can’t add items after that.
  - If attempt to add items to a Finalized session, the API returns 400 Bad Request with: "Cannot add items to a finalized session."
- On PUT /api/v3/sessions, the response body for a "500" error has been simplified.
- Add a 200 response on some endpoints where it was missing.
- The schema for MobileStatus in Sessions endpoints clarifies the following distinct enumerated values:
  1. Active
  2. Finalized
  3. Recount
  4. Processed


### 3.25.0.4

- This version was released on 2025-07/05.
- Fix typo in the path displaying the production endpoints.
- For fetching on-hand counts, clarify advantage of `POST /inventory` over the delayed updates from `GET /items`.


### 3.25.0.2

- This version was released on 2025-04/29.
- Improved documentation regarding `POST /interfaces/thirdpartycodes`.
- Improved documentation regarding `POST /transactions`.
- Disabled the "Try It" button for endpoints that do not support it.


### 3.25.0.1

- This version was released on 2025-04/25.
- Improved documentation regarding timestamps.


### 3.25.0.0

- This version was released on 2025-04/23.
- Significantly improved performance on the `GET /items` endpoint.
- Fixed a missing pagination response header on the `GET /stores/{id}/interfaces/thirdpartycodes` endpoint.
- No changes to the API documentation.


### 3.24.0.2

- This version was released on 2025-03/13.
- Added `GET /productiongroups` endpoint.
- Added `GET /recipes` and `GET /recipes/{id}` endpoints.
- Added `GET /recipetypes` endpoint.
- Improved documentation and examples for using timestamps in parameters and payloads.


### 3.23.1.1

- This version was released on 2025-01/24.
- More examples for using the `Expand=Dimensions` query parameter to retrieve more than ten dimensions per item.
- For "Attached Files" endpoint group, remove irrelevant reference to "purchasing documents".
- Schema refinements:
  - Documentation of payload for Transfers clarifies recent changes:
    - The "needBy" property takes over for the now deprecated "due" property.
    - The "vendor" property is now deprecated.


### 3.23.0.1

- This version was released on 2025-01/20.
- GET /transfers added as new endpoint.
- GET /transfers/{id} added as new endpoint.
- Expand Dimensions option added as a new query parameter to the following endpoints:
  - GET /items
  - GET /items/{id}
  - GET /stores/{id}/items
- Many refinements to schema fields and their descriptions including the following:
  - Defined and documented CommdocLineItem as an independent object in the schema.
  - Defined and documented a Level schema as an independent object used by CommdocLineItem.
  - Add a new "dimensions" array property to the ItemGet schema for use with the query option.
  - Add a status property to PurchaseOrderGet payload.
  - New properties and documentation of payload for Transfers.
  - Defined and documented TransferLine as an independent object used by Transfer object.
- Fixed a broken link for POST /transfers/{id}
- This is the first update with functional API differences since 3.22.2.0.


### 3.22.2.4

- This version was released on 2025-01/02.
- PUT /vendors endpoint documentation now lists 'id' as a required field.
- POST /transactions endpoint description is reformatted to embed examples into the 
sample request pane for better readability.
- Other than the documentation update, there are no functional API differences 
since 3.22.2.0.


### 3.22.2.3

- This version was released on 2024-12/26.
- API documentation with a new UI is now available at 
[developer.yellowdogsoftware.com](https://developer.yellowdogsoftware.com/)
- Other than the documentation update, there are no functional API differences since 
since 3.22.2.0.


### 3.22.2.0

- This version was released on 2024-12/04.
- Improved documentation concerning sessions.
- Improved documentation for getting stores by ID.
- Code factoring to prepare for future improvements.


### 3.22.1.0

- This version was released on 2024-11/06.
- Added new endpoints for invoices:
  - PUT /invoices/staged/{stagedInvoiceId}
  - PATCH /invoices/staged/{stagedInvoiceId}
  - POST /invoices/staged/{stagedInvoiceId}/lines
  - GET /invoices/staged/{stagedInvoiceId}/original-document
- Improved model and documentation concerning 422 errors.
- Improved documentation concerning creation of third party codes.


### 3.21.3.0

- This version was released on 2024-09/10.
- Added DateTime examples to documentation.
- Improve documentation concerning BeanAccountId.
- Improve documentation concerning TransactionLine.
- Fix a pagination error when getting items by StoreId.