NAME
Parse::SAMGov::Entity - Object to denote each Entity in SAM
VERSION
version 0.201
SYNOPSIS
### for V2 files
my $e_v2 = Parse::SAMGov::Entity->new(UEI => 12345);
say $e_v2; #... stringification supported ...
### for V1 files
my $e_v1 = Parse::SAMGov::Entity->new(DUNS => 12345);
say $e_v1; #... stringification supported ...METHODS
UEI
This holds the SAM Unique Entity Identifier (UEI) and is 12 characters long. This number is only valid for V2 files on or after 2022.
DUNS
This holds the unique identifier of the entity, currently the Data Universal Numbering System (DUNS) number. This has a maximum length of 9 characters. This number can be gotten from Dun & Bradstreet. This is only valid for V1 files on or before 2021.
DUNSplus4
This holds the DUNS+4 value which is of 4 characters. If an entity doesn't have this value set, it will be set as '0000'. This is only valid for V1 files on or before 2021.
EEFTI
The Entity EFT Indicator is an entity-selected Electronics Funds Transfer (EFT) Identifier used to distinguish more than one remittance location for payment. An entity can only provide an Entity EFT Indicator if they provide an additional set of EFT information. If the entity does not need to provide additional EFT information, the registration will show a value of null. CAGE codes are assigned at the Entity EFT Indicator level.
CAGE
This holds the CAGE code of the Entity.
DODAAC
This holds the DODAAC code of the entity.
extract_code
This denotes whether the SAM entry is active or expired during extraction of the data.
updated
This denotes whether the SAM entry has been updated recently. Has a boolean value of 1 if updated and 0 or undef otherwise.
regn_purpose
This denotes whether the purpose of registration is Federal Assistance Awards, All Awards, IGT-only, Federal Assistance Awards & IGT or All Awards & IGT.
regn_date
Registration date of the entity with the input in YYYYMMDD format and it returns a DateTime object.
expiry_date
Expiration date of the registration of the entity. The input is in YYYYMMDD format and it returns a DateTime object.
lastupdate_date
Last update date of the registration of the entity. The input is in YYYYMMDD format and it returns a DateTime object.
activation_date
Activation date of the registration of the entity. The input is in YYYYMMDD format and it returns a DateTime object.
name
The legal business name of the entity.
dba_name
The Doing Business As (DBA) name of the entity.
company_division
The company division (V1) listed in the entity. Same as Entity Division in V2.
division_no
The divison number of the company division (V1) or entity division (V2).
physical_address
This is the physical address of the entity represented as a Parse::SAMGov::Entity::Address object.
start_date
This denotes the business start date. It takes as input the date in YYYYMMDD format and returns a DateTime object.
fiscalyear_date
This denotes the current fiscal year end close date in YYYYMMDD format and returns a DateTime object.
url
The corporate URL is denoted in this method. Returns a URI object and takes a string value.
entity_structure
Get/Set the entity structure of the entity. This is a 2-letter code
entity_structure_descriptions
Describe the 2-letter code for entity structure (V2).
incorporation_state
Get/Set the two-character abbreviation of the state of incorporation.
incorporation_country
Get/Set the three-character abbreviation of the country of incorporation.
biztype
Get/Set the various business types that the entity holds. Requires an array reference. The full list of business type codes can be retrieved from the SAM Functional Data Dictionary.
is_smallbiz
Returns 1 or 0 if the business is defined as a small business or not.
NAICS
Get/Set the NAICS codes for the entity. This is a hash reference with the keys being the numeric NAICS codes and the values being a hash reference with the following keys:
{
124567 => {
small_biz => 1,
exceptions => {
small_biz => 0,
# ... undocumented others ...
},
},
# ...
}
whether it is a small
business (value is 1) or not (value is 0) or has an exception (value is 2).PSC
Get/Set the PSC codes for the entity. This requires an array reference.
creditcard
This denotes whether the entity uses a credit card.
correspondence_type
This denotes whether the entity prefers correspondence by mail, fax or email. Returns a string of value 'mail', 'fax' or 'email'.
mailing_address
The mailing address of the entity as a Parse::SAMGov::Entity::Address object.
POC_gov
This denotes the Government business Point of Contact for the entity and holds an Parse::SAMGov::Entity::PointOfContact object.
POC_gov_alt
This denotes the alternative Government business Point of Contact for the entity and holds an Parse::SAMGov::Entity::PointOfContact object.
POC_pastperf
This denotes the Past Performance Point of Contact for the entity and holds an Parse::SAMGov::Entity::PointOfContact object.
POC_pastperf_alt
This denotes the alternative Past Performance Point of Contact for the entity and holds an Parse::SAMGov::Entity::PointOfContact object.
POC_elec
This denotes the electronic business Point of Contact for the entity and holds an Parse::SAMGov::Entity::PointOfContact object.
POC_elec_alt
This denotes the alternative electronic business Point of Contact for the entity and holds an Parse::SAMGov::Entity::PointOfContact object.
delinquent_fed_debt
Get/Set the delinquent federal debt flag. Also known as Debt Subject to Offset Flag in V2.
exclusion_status
Get/Set the exclusion status flag.
is_private
This flag denotes whether the listing is private or not.
dnb_open_data
This flag denotes whether this is a D&B Open Data or not. V2 only.
SBA
This holds a hash-ref of Small Business Administration codes such as Hubzone, 8(a) certifications and the expiration dates. The structure looks like below:
{
A4 => { description => 'SBA Certified Small Disadvantaged Busines',
expiration => '2016-12-01', #... this is a DateTime object...
},
} disaster_response
This holds an array ref of disaster response (FEMA) codes that the entity falls under, if applicable.
AUTHOR
Vikas N Kumar <vikas@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2023 by Selective Intellect LLC.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.