Identity
extends DataTransferObject
in package
Users are uniquely identified by their email across all of FreshBooks, so if `leafy@example.com` is an Owner of one account and gets added as a Client on another, they will have some access to both. They could then open a second business of their own, or be added as an employee of another person’s business.
Tags
Table of Contents
Properties
- $businessMemberships : array<string|int, mixed>|null
- $confirmedAt : DateTimeImmutable
- $createdAt : DateTimeImmutable
- $email : string
- $firstName : string
- $identityId : int
- $identityUUID : string
- $language : string
- $lastName : string
Properties
$businessMemberships
public
array<string|int, mixed>|null
$businessMemberships
Attributes
- #[CastWith]
- \Spatie\DataTransferObject\Casters\ArrayCaster::class
- $itemType: \amcintosh\FreshBooks\Model\BusinessMembership::class
- #[MapFrom]
- 'business_memberships'
$confirmedAt
public
DateTimeImmutable
$confirmedAt
Date the identity confirmed their email.
Attributes
- #[CastWith]
- \amcintosh\FreshBooks\Model\Caster\ISODateTimeImmutableCaster::class
- #[MapFrom]
- 'confirmed_at'
$createdAt
public
DateTimeImmutable
$createdAt
Date the identity was created.
Attributes
- #[CastWith]
- \amcintosh\FreshBooks\Model\Caster\ISODateTimeImmutableCaster::class
- #[MapFrom]
- 'created_at'
public
string
$email
The identity's email.
$firstName
public
string
$firstName
The identity's first name.
Attributes
- #[MapFrom]
- 'first_name'
$identityId
public
int
$identityId
The identity's unique id.
Attributes
- #[MapFrom]
- 'identity_id'
$identityUUID
public
string
$identityUUID
UUID of the identity.
FreshBooks will be moving from id to identity_uuid in future API calls.
Attributes
- #[MapFrom]
- 'identity_uuid'
$language
public
string
$language
The language used by the identity in FreshBooks.
$lastName
public
string
$lastName
The identity's last name.
Attributes
- #[MapFrom]
- 'last_name'