Fax data model

Updated:

A fax sent or received through a phone number

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model
FieldTypeRequiredDescription
idstringNoUnique identifier for this fax object
created_atstring (date-time)NoThe date that this fax object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this fax object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
typeenumNoWhether the fax was received (INBOUND) or sent (OUTBOUND) Values: INBOUND, OUTBOUND
statusenumNoThe current or final status of the fax Values: QUEUED, SENDING, DELIVERED, RECEIVING, RECEIVED, FAILED, CANCELED, OTHER
from_telephonestringNoThe E.164 phone number the fax was sent from
to_telephonestringNoThe E.164 phone number the fax was sent to
pagesnumberNoNumber of pages in the fax
media_urlstringNoURL of the fax document (PDF); on create, a public URL of the document to send
user_idstringNoThe user that sent or owns the fax (reference to HrisEmployee)
cost_amountnumberNoWhat the integration charged for the fax
currencystringNoISO 4217 currency of cost_amount
error_messagestringNoWhy the fax failed
metadataUcMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type UcFax = {
	id?: string; // Unique identifier for this fax object
	created_at?: string-time; // The date that this fax object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this fax object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	type?: 'INBOUND' | 'OUTBOUND'; // Whether the fax was received (INBOUND) or sent (OUTBOUND)
	status?: 'QUEUED' | 'SENDING' | 'DELIVERED' | 'RECEIVING' | 'RECEIVED' | 'FAILED' | 'CANCELED' | 'OTHER'; // The current or final status of the fax
	from_telephone?: string; // The E.164 phone number the fax was sent from
	to_telephone?: string; // The E.164 phone number the fax was sent to
	pages?: number; // Number of pages in the fax
	media_url?: string; // URL of the fax document (PDF); on create, a public URL of the document to send
	user_id?: string; // The user that sent or owns the fax (reference to HrisEmployee)
	cost_amount?: number; // What the integration charged for the fax
	currency?: string; // ISO 4217 currency of cost_amount
	error_message?: string; // Why the fax failed
	metadata?: [];
	raw?: any; // The raw data returned by the integration for this fax
}

Zod

Zod
import { z } from 'zod';

export const ZodUcFax = z.object({
	id: z.string().optional().describe("Unique identifier for this fax object"),
	created_at: z.string-time().optional().describe("The date that this fax object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this fax object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	type: z.enum("INBOUND", "OUTBOUND").optional().describe("Whether the fax was received (INBOUND) or sent (OUTBOUND)"),
	status: z.enum("QUEUED", "SENDING", "DELIVERED", "RECEIVING", "RECEIVED", "FAILED", "CANCELED", "OTHER").optional().describe("The current or final status of the fax"),
	from_telephone: z.string().optional().describe("The E.164 phone number the fax was sent from"),
	to_telephone: z.string().optional().describe("The E.164 phone number the fax was sent to"),
	pages: z.number().optional().describe("Number of pages in the fax"),
	media_url: z.string().optional().describe("URL of the fax document (PDF); on create, a public URL of the document to send"),
	user_id: z.string().optional().describe("The user that sent or owns the fax (reference to HrisEmployee)"),
	cost_amount: z.number().optional().describe("What the integration charged for the fax"),
	currency: z.string().optional().describe("ISO 4217 currency of cost_amount"),
	error_message: z.string().optional().describe("Why the fax failed"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class UcFaxType(str, Enum):
	INBOUND = 'INBOUND'
	OUTBOUND = 'OUTBOUND'

@dataclasses.dataclass
class UcFaxStatus(str, Enum):
	QUEUED = 'QUEUED'
	SENDING = 'SENDING'
	DELIVERED = 'DELIVERED'
	RECEIVING = 'RECEIVING'
	RECEIVED = 'RECEIVED'
	FAILED = 'FAILED'
	CANCELED = 'CANCELED'
	OTHER = 'OTHER'

@dataclasses.dataclass
class UcFax:
	"""Unique identifier for this fax object"""
	id: Optional[str]
	"""The date that this fax object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this fax object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Whether the fax was received (INBOUND) or sent (OUTBOUND)"""
	type: Optional[UcFaxType]
	"""The current or final status of the fax"""
	status: Optional[UcFaxStatus]
	"""The E.164 phone number the fax was sent from"""
	from_telephone: Optional[str]
	"""The E.164 phone number the fax was sent to"""
	to_telephone: Optional[str]
	"""Number of pages in the fax"""
	pages: Optional[int]
	"""URL of the fax document (PDF); on create, a public URL of the document to send"""
	media_url: Optional[str]
	"""The user that sent or owns the fax (reference to HrisEmployee)"""
	user_id: Optional[str]
	"""What the integration charged for the fax"""
	cost_amount: Optional[int]
	"""ISO 4217 currency of cost_amount"""
	currency: Optional[str]
	"""Why the fax failed"""
	error_message: Optional[str]
	metadata: Optional[PropertyUcFaxMetadata]
Are we missing anything? Let us know
Was this page helpful?