<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

FS::realestate_unit

NAME

FS::realestate_unit - Object representing a realestate_unit record

SYNOPSIS

  use FS::realestate_unit;

  $record = new FS:realestate_unit  \%values;
  $record = new FS::realestate_unit {
    realestatelocnum => 42,
    agentnum         => 1,
    unit_title       => 'Ste 404',
  };

  $error = $record->insert;
  $error = $new_rec->replace($record)
  $error = $record->check;

  $location = $record->location;

DESCRIPTION

An FS::realestate_unit object represents an invoicable unit of real estate. Object may represent a single property, such as a rental house. It may also represent a group of properties sharing a common address or identifier, such as a shopping mall, apartment complex, or office building, concert hall.

A FS::realestate_unit object must be associated with a FS::realestate_location

FS::realestate_unit inherits from FS::Record.

The following fields are currently supported:

realestatenum
realestatelocnum
agentnum
unit_title
disabled

METHODS

new HASHREF (see FS::Record)
insert (see FS::Record)
delete
  FS::realestate_unit records should never be deleted, only disabled
replace OLD_RECORD (see FS::Record)
check (see FS::Record)
agent

Returns the associated agent, if any, for this object

location
  Return the associated FS::realestate_location object
custnum

Pull the assigned custnum for this unit, if provisioned

SUBROUTINES

SEE ALSO

FS::record, FS::realestate_location, FS::svc_realestate

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 117:

'=item' outside of any '=over'

Around line 148:

You forgot a '=back' before '=head1'

<% include ('/elements/footer.html' ) %>