Available Data Fields
The following data fields are available for use in the AMR integration:
Even though a field is available, it may not always contain data.
The data will be populated based on the Credential Template and the input form presented to the user.
- Manual Input fields: These fields will remain empty unless the user has entered data.
- Non-Manual Input fields: These fields will be automatically populated by the Breeze System. However, for Number Range fields, the values are determined by the Number Range settings in the Credential Template, if configured.
Data Fields
| Source Object | Field Name | Description | Manual Input | Example | Data Type |
|---|---|---|---|---|---|
| Credential | Id | The unique identifier of the Credential. | No | 66e1ad73bd756adad71c632c | Text |
| Credential | Status | Current status of the Credential. | No | Active | Text |
| Credential | Card Number Manual | The manually entered card number. | Yes | 123456 | Text |
| Credential | Card Valid Until Date | Expiration date of the Credential. | * | 2022-12-31 | Date |
| Credential | Company Name | Name of the company. | Yes | Your Company Inc. | Text |
| Credential | Company Org No | Organization number of the company. | Yes | 123456789 | Text |
| Credential | Extra 1-31 | Additional custom fields. | Yes | Extra 1 | Text |
| Credential | Extra Date 1-5 | Additional custom date fields. | Yes | 2022-12-31 | Date |
| Credential | Message To Access Vendor | Message to the access vendor. | Yes | Please allow access | Text |
| Credential | Order Cost Centre | Cost center of the order. | Yes | 123456 | Text |
| Credential | Person First Name | First name of the person. | Yes | John | Text |
| Credential | Person Last Name | Last name of the person. | Yes | Doe | Text |
| Credential | Person Employee No | Employee number of the person. | Yes | 123456 | Text |
| Credential | Person Country | Country of the person. | Yes | Norway | Text |
| Credential | Person Country Code | Country code of the person. | Yes | NO | Text |
| Credential | Person Department | Department of the person. | Yes | IT | Text |
| Credential | Person Education Code | Education code of the person. | Yes | 123456 | Text |
| Credential | Person Gender | Gender of the person. | Yes | Male | Text |
| Credential | Person Personal No | The personal number of the person. | Yes | 123456 | Text |
| Credential | Person Photo 1 | Person's photo, base64 encoded. | Yes | base64 | Base64 encoded image |
| Credential | Person Photo 2 | Alternative person photo, base64 encoded. | Yes | base64 | Base64 encoded image |
| Credential | Person Pin | Person's PIN | Yes | 1234 | Text |
| Credential | Person Signature | Person's signature, base64 encoded. | Yes | base64 | Base64 encoded image |
| Credential | Person Title | The title of the person. | Yes | CEO | Text |
| Credential | Range 1-3 Formula 1 | Calculated result of configured formula | No | 0EAA25CE | Text |
| Credential | Range 1-3 Formula 2 | Calculated result of configured formula | No | 1EAA2511 | Text |
| Credential | Range 1-3 Formula 3 | Calculated result of configured formula | No | 25ECBA32 | Text |
| Credential | Range 1-3 Full Sequence | The full sequence of the number range. | No | 00042123409 | Text |
| Credential | Range 1-3 Prefix | The prefix of the number range. | No | 000 | Text |
| Credential | Range 1-3 Sequence | The sequence of the number range. | No | 1234 | Text |
| Credential | Range 1-3 Site Code | The site code of the number range. | No | 42 | Text |
| Credential | Range 1-3 Suffix | The suffix of the number range. | No | 9 | Text |
| Credential | Range 1-3 Version Number | The version number of the number range. | No | 1 | Text |
| Credential | Template Formula 1-3 | Calculated result of configured formula. | No | 00045145 | Text |
| Credential | Requester Email | The email of the requester. | No | requester@yourcompany.inc | Text |
| Credential | Requester First Name | The first name of the requester. | No | John | Text |
| Credential | Requester Last Name | The last name of the requester. | No | Doe | Text |
| Credential | Requester Phone | The phone number of the requester. | No | 123456 | Text |
| Credential | Tenant Id | The unique identifier of the Tenant. | No | 66e1ad73bd756adad71c632c | Text |
| Order | Id | The unique identifier of the Order. | No | 66e1ad73bd756adad71c632c | Text |
| Order | Status | Current status of the Order. | No | Active | Text |
| Order | Order Number | The order number. | No | 123456 | Text |
| Order | Order Placed | The date the order was placed. | No | 2022-12-31 | Date |
| Order | Order Reference | The reference of the order. | Yes | 123456 | Text |
| Order | Contact Email | The email of the contact person. | Yes | someperson@yourcompany.inc | Text |
| Order | Contact Phone | The phone number of the contact person. | Yes | +4744444444 | Text |
| Order | User Id | The unique identifier of the User. | No | 66e1ad73bd756adad71c632c | Text |
| Order | User Email | The email of the User. | No | someuser@yourcompany.inc | Text |
| Tenant | Id | The unique identifier of the Tenant. | No | 66e1ad73bd756adad71c632c | Text |
| Tenant | Number | The number of the Tenant. | No | 123456 | Text |
| Tenant | Name | The name of the Tenant. | No | Your Company Inc. | Text |
| Tenant | External Id | The external identifier of the Tenant. | No | 123456 | Text |
| Tenant | Contact Email | The email of the contact person. | No | someadmin@yourcompany.inc | Text |
| Template | Id | The unique identifier of the Template. | No | 66e1ad73bd756adad71c632c | Text |
| Template | Name | The name of the Template. | No | Your Template | Text |
* The Card Valid Until Date field can be either manually entered or automatically populated depending on the Credential Template settings.
Data Types
Text
Text data type will transfer the data as plain text.
Date
Date data type will transfer the data as a date. The date format will be in a YYYY-MM-DD format.
Base64 Encoded Image
Base64 encoding is a method of converting binary data, such as an image, into a string format. This is useful for transmitting image data in text-based formats, such as JSON or HTML. When data is encoded in Base64, it represents the binary data as a series of ASCII characters. This makes it possible to include images in formats that otherwise only support text. In this context, Base64-encoded images are used to transfer picture data, which can then be decoded back into the original image format by the receiving system.