Skip to navigation
Attraction WalletAttraction Wallet

Find Wallet

Find a wallet by any of its external references.

When activeAssetsOnly=true, assets that can no longer be used are left out of assets. This covers assets that have been revoked, spent, replaced, or that have passed their validity. Assets that are not usable yet, such as a ticket valid from a future date or a membership card awaiting activation, are still returned. The wallet itself is always returned, even when every one of its assets is left out. The parameter has no effect unless withAssets=true.

The asset list is meant for display. An application acting on an asset should validate it at the point of use.

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

referenceNumberstringOptional
Any external identity associated with the wallet.
referenceNumbersstringOptional
A comma separated list of external reference numbers used when searching for wallets.
withAssetsbooleanOptional
Indicates whether the asset should be included in the response.
withDetailsbooleanOptional
Indicates whether the asset details should be included in the response.
activeAssetsOnlybooleanOptional

When true, assets that can no longer be used are left out of assets. Defaults to false.

languageCodestringOptional
The language code for localization of item description purposes.

Response

This endpoint returns a list of objects.
descriptionstring

A human-readable description of the wallet.

expiryDatetimestring
The expiry datetime of the wallet in ISO 8601 format. Use an empty string if not applicable.
lastPrintedAtstring
The datetime when the wallet was last printed in ISO 8601 format. Use an empty string if not applicable.
printCountinteger
The number of times the wallet has been printed.
referenceNumberstring
The visual reference number associated with the wallet.
walletIdUUID
A globally unique identifier for the wallet.
assetslist of objectsOptional
externalReferenceNumberstringOptional

The first external reference on the wallet that is neither blocked nor expired. null when there is none.

originatesFromDescriptionstringOptional
The item description from which the wallet originates.
originatesFromItemNostringOptional
The item number from which the wallet originates.