Xero-OpenAPI icon indicating copy to clipboard operation
Xero-OpenAPI copied to clipboard

Missing description field for assets

Open orangethunder opened this issue 5 months ago • 2 comments

Expected Behavior

When retrieving an individual asset from the API, I expect it to have a "description" field, as documented in the official API.

Current Behavior

There is no "description" field.

Possible Solution

Add the "description" field to the Asset entity definition. Make it clear in the documentation that it will be null when listing assets, and only potentially have a value when retrieving a single asset. Alternatively, split the Asset entity definition into one used for listing assets and another for retrieving an individual asset.

Steps to Reproduce (for bugs)

Call get_asset_by_id on the assets API client (or whatever the equivalent method is in your chosen programming languate).

orangethunder avatar Sep 09 '24 11:09 orangethunder