Find Wallet

Find a wallet by any of its external references.

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.

Response

This endpoint returns a list of objects.
walletIdUUID
A globally unique identifier for the wallet.
referenceNumberstring
The visual reference number associated with the wallet.
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.
originatesFromItemNostring or null
The item number from which the wallet originates.
originatesFromDescriptionstring or null
The item description from which the wallet originates.
externalReferenceNumberstring or null
The visual reference number associated with the wallet.
assetslist of objects or null