# Fax Inbound UDR Report

This example retrieves inbound fax Usage Detail Records (UDRs) for a given period. The response contains the full reception lifecycle (call details, document processing, email delivery, archiving status) plus billing-related fields.

For complete field definitions and advanced options, see the [GraphQL API Reference](https://developers.retarus.com/common/sdl).

## Query

```graphql
query faxInUdrReport (
  $customerId: String!
  $datePeriod: DatePeriod!
  $pageIndex: Int
  $pageSize: Int
  $sort: SortDirection
) {
  faxInUdrReport(
    customerId: $customerId
    datePeriod: $datePeriod
    page: $pageIndex
    size: $pageSize
    sort: $sort      
  ) {
    content {
      accountingService
      allPages
      archivePurgeAt
      archivingStatus
      baudRate
      billingCode
      callConnectedAt
      calledCountry
      calledCsId
      calledNumber
      calledNumberDisplay
      callingNumber
      callingTsId
      callStartedAt
      confirmedPages
      customerId
      deliveryRecipients
      deliverySender
      deliverySenderUser
      discardedPages
      docMimeType
      documentDeliveryStatus
      faxFileSize
      faxTransmitStatus
      keyTimestamp
      recipientsCount
      resolution
      secondaryDeliveryRecipients
      virtualPagesBilled
    }
    pageIndex
    pageSize
    hasMoreElements
  }
}
```

## Variables

```json
{
	"customerId": "XXXXX",
	"datePeriod": {
		"fromIncluded": "2025-06-04T08:00:00.000Z",
		"toExcluded": "2025-06-04T08:54:00.000Z"
	},
	"pageIndex": 0,
	"pageSize": 3,
	"sort": "ASC"
}
```

## Response

```json
{
	"data": {
		"faxInUdrReport": {
			"content": [
				{
					"accountingService": "F2Mail",
					"allPages": 2,
					"archivePurgeAt": "2025-07-04T00:00:00Z",
					"archivingStatus": "SUCCEEDED",
					"baudRate": 9600,
					"billingCode": "Pos. 2 Fax",
					"callConnectedAt": null,
					"calledCountry": "DEU",
					"calledCsId": "+494023*********",
					"calledNumber": "0049/40/23*****-****",
					"calledNumberDisplay": "+494023*********",
					"callingNumber": "+499*********",
					"callingTsId": "+499*********",
					"callStartedAt": "2025-06-04T07:59:02.721Z",
					"confirmedPages": 2,
					"customerId": "XXXXX",
					"deliveryRecipients": "fax_recipient@example.com",
					"deliverySender": "xxxxxxxxxx@retarus.net",
					"deliverySenderUser": "xxxxxx-service@retarus.net",
					"discardedPages": 0,
					"docMimeType": "image/tiff",
					"documentDeliveryStatus": "SUCCEEDED",
					"faxFileSize": 29412,
					"faxTransmitStatus": "OK",
					"keyTimestamp": "2025-06-04T08:00:04.721Z",
					"recipientsCount": 1,
					"resolution": "204x98",
					"secondaryDeliveryRecipients": "",
					"virtualPagesBilled": null
				}
				// more items ...
			],
			"pageIndex": 0,
			"pageSize": 3,
			"hasMoreElements": true
		}
	}
}
```

> **Note**  Additional records (up to the requested `pageSize`) are omitted for brevity.


## Field Reference

| **Field** | **Description** |
|  --- | --- |
| `accountingService` | Service identifier for billing and cost allocation |
| `allPages` | Total pages received in the fax document |
| `archivePurgeAt` | UTC timestamp when the archived document will be automatically deleted |
| `archivingStatus` | Archival status of the document |
| `baudRate` | Fax transmission speed in bits per second |
| `billingCode` | Cost center or department identifier for internal billing |
| `callConnectedAt` | UTC timestamp when the fax call was established |
| `calledCountry` | ISO 3166-1 alpha-3 country code of the called (destination) fax number |
| `calledCsId` | Called subscriber identifier reported by the fax protocol |
| `calledNumber` | Original dialed fax number as received |
| `calledNumberDisplay` | Standardized international format of the called number |
| `callingNumber` | Sender's fax number in international format |
| `callingTsId` | Calling terminal subscriber identifier from the fax header |
| `callStartedAt` | UTC timestamp when the fax transmission began |
| `confirmedPages` | Number of pages successfully received without errors |
| `customerId` | Retarus customer account identifier |
| `deliveryRecipients` | Primary email recipient(s) for delivered documents |
| `deliverySender` | System email address used as the sender for document delivery |
| `deliverySenderUser` | Service account used for email delivery |
| `discardedPages` | Number of pages dropped due to errors or quality issues |
| `docMimeType` | MIME type of the delivered document |
| `documentDeliveryStatus` | Email delivery status |
| `faxFileSize` | Processed document size in bytes |
| `faxTransmitStatus` | Overall reception result |
| `keyTimestamp` | Primary record timestamp used for chronological sorting |
| `recipientsCount` | Total number of email recipients |
| `resolution` | Fax resolution as `horizontal` x `vertical` DPI |
| `secondaryDeliveryRecipients` | Additional recipient addresses (empty string if none) |
| `virtualPagesBilled` | Billing page count when different from actual pages (null if same as `allPages`) |