---
name: "LedgerSMB::Location"
section: "3pm"
platform: "linux"
package: "ledgersmb"
version: "1.3.40-1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/LedgerSMB::Location"
---

# LedgerSMB::Location(3pm)

LedgerSMB class for managing Business Locations

## NAME

LedgerSMB::Location - LedgerSMB class for managing Business Locations

## SYOPSIS

This module contains location management routines.  This subclasses  LedgerSMB::DBObject to provide access to automatice mapping of function  arguments and the like.

## METHODS

- delete

  - save

  Saves the location.  Properties to be set to be saved are:

  \* location\_id: Optional:  Overwrite location with this id. \* address1: First line of the address. \* address2: Second line of the address \* address3: Third line of the address \* city \* state: state or province \* zipcode: zipcode or mail code,  \* country:  The id of the country as per the country table

- get

  Retrieves a location record based on the id field of the object.  Merges the  properties into the object.

- search Returns anarrayref (and stores it on $self-\>{search\_results} based on the search of addresses. Not currently used.

  Attributes used as search criteria: address1: Partial match for address line 1 address2: Partial match for address line 2, city:  Partial match for city name state: Partial match for state or province name,  zipcode:  Partial match for zip or postal code, country: Partial name for country name)

- list\_all

  Provides a list of all locations, ordered by country, then city, then state.

- delete

  Deletes the location identified by id

## Copyright (C) 2007, The LedgerSMB core team.

This file is licensed under the Gnu General Public License version 2, or at your option any later version.  A copy of the license should have been included with your software.