> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Financial data

> Reference the financial data fields used across Midaz, CRM, Pix, and Fees Engine: banking details, Pix keys, amounts, and currency codes.

This page brings together all financial information fields used across Midaz, CRM, Pix, and Fees Engine.

## 1. Banking data

***

| Field         | Description                       | Used in  |
| ------------- | --------------------------------- | -------- |
| branch        | Bank branch code                  | CRM, Pix |
| account       | Account number                    | CRM      |
| accountNumber | Generic account number            | Pix      |
| accountDigit  | Check digit                       | Pix      |
| agency        | Bank agency                       | Pix      |
| accountType   | Account type                      | CRM, Pix |
| iban          | International Bank Account Number | CRM      |
| bankId        | Bank identifier                   | CRM, Pix |
| openingDate   | Account opening date              | CRM      |

## 2. Pix keys

***

| Field                | Description                             | Used in |
| -------------------- | --------------------------------------- | ------- |
| key                  | Pix key value                           | Pix     |
| keyType              | Key type (email, phone, tax ID, random) | Pix     |
| requiresConfirmation | Requires token confirmation             | Pix     |
| confirmationToken    | Token for key confirmation              | Pix     |
| claimId              | Claim identifier                        | Pix     |
| claimReason          | Claim reason                            | Pix     |
| claimType            | Claim type                              | Pix     |
| authorizationCode    | Authorization code                      | Pix     |
| checked              | Key verification flag                   | Pix     |

## 3. Financial transactions

***

| Field           | Description                         | Used in         |
| --------------- | ----------------------------------- | --------------- |
| amount          | Monetary amount                     | Midaz, Pix, Fee |
| value           | Numeric value                       | Fee, Pix        |
| totalAmount     | Total amount of the operation       | Pix             |
| minimumAmount   | Minimum allowed amount              | Fee             |
| maximumAmount   | Maximum allowed amount              | Fee             |
| originalAmount  | Amount before fees                  | Fee             |
| afterFeesAmount | Amount after fee application        | Fee             |
| description     | Transaction description             | Midaz, Pix      |
| asset           | Asset code (BRL, USD)               | Midaz, Fee      |
| code            | Transaction or authorization code   | Midaz           |
| route           | Operation route                     | Midaz           |
| pending         | Pending status                      | Midaz           |
| priority        | Priority (high/medium/low)          | Pix             |
| flow            | Transaction flow (cash-in/cash-out) | Pix             |
| isPixSaque      | Pix withdrawal flag                 | Pix             |
| isPixTroco      | Pix cashback flag                   | Pix             |
| isReversal      | Reversal flag                       | Pix             |
| isInternal      | Internal transaction flag           | Pix             |
| reversalType    | Type of reversal                    | Pix             |
| refundId        | Refund identifier                   | Pix             |
| returnId        | Return identifier                   | Pix             |
| returnReason    | Reason for return                   | Pix             |
| returnedAt      | Return timestamp                    | Pix             |
| failureReason   | Failure reason                      | Pix             |

## 4. Pix QR codes

***

| Field             | Description                     | Used in |
| ----------------- | ------------------------------- | ------- |
| qrCode            | Pix QR Code string              | Pix     |
| qrCodeType        | QR type (static/dynamic)        | Pix     |
| txId              | Transaction ID (up to 25 chars) | Pix     |
| recipientName     | Recipient name                  | Pix     |
| expirationTime    | Expiration time in seconds      | Pix     |
| isValid           | Whether QR is valid             | Pix     |
| validationMessage | Validation message              | Pix     |
| additionalData    | Additional QR data              | Pix     |

## 5. Limits and controls

***

| Field      | Description | Used in |
| ---------- | ----------- | ------- |
| limitType  | Limit type  | Pix     |
| periodType | Period type | Pix     |

\| used          | Amount used in the period                 | Pix     |
\| remaining     | Remaining amount                          | Pix     |
\| resetDate     | Period reset date                         | Pix     |
\| waivedAccounts| Accounts exempt from fees                 | Fee     |