Class: GOBL::Org::Party

Inherits:
GOBL::Object show all
Defined in:
lib/generated/gobl/org/party.rb

Overview

Party represents a person or business entity.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Party structure

'https://gobl.org/draft-0/org/party'

Instance Attribute Summary collapse

Method Summary

Methods inherited from GOBL::Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#addresses ⇒ Array<GOBL::Org::Address> (readonly)

Regular post addresses for where information should be sent if needed.

Returns:



58
 
# File 'lib/generated/gobl/org/party.rb', line 58

property :addresses, [GOBL::Org::Address]

#alias ⇒ String (readonly)

Alternate short name.

Returns:

  • (String) 


33
 
# File 'lib/generated/gobl/org/party.rb', line 33

property :alias, String

#emails ⇒ Array<GOBL::Org::Email> (readonly)

Electronic mail addresses

Returns:



63
 
# File 'lib/generated/gobl/org/party.rb', line 63

property :emails, [GOBL::Org::Email]

#ext ⇒ GOBL::Tax::Extensions (readonly)

Extension code map for any additional regime specific codes that may be required.

Returns:



88
 
# File 'lib/generated/gobl/org/party.rb', line 88

property :ext, GOBL::Tax::Extensions

#identities ⇒ Array<GOBL::Org::Identity> (readonly)

Set of codes used to identify the party in other systems.

Returns:



43
 
# File 'lib/generated/gobl/org/party.rb', line 43

property :identities, [GOBL::Org::Identity]

#inboxes ⇒ Array<GOBL::Org::Inbox> (readonly)

Digital inboxes used for forwarding electronic versions of documents

Returns:



53
 
# File 'lib/generated/gobl/org/party.rb', line 53

property :inboxes, [GOBL::Org::Inbox]

#label ⇒ String (readonly)

Label can be used to provide a custom label for the party in a given context in a single language, for example “Supplier”, “Host”, or similar.

Returns:

  • (String) 


23
 
# File 'lib/generated/gobl/org/party.rb', line 23

property :label, String

#logos ⇒ Array<GOBL::Org::Image> (readonly)

Images that can be used to identify the party visually.

Returns:



83
 
# File 'lib/generated/gobl/org/party.rb', line 83

property :logos, [GOBL::Org::Image]

#meta ⇒ GOBL::CBC::Meta (readonly)

Any additional semi-structured information that does not fit into the rest of the party.

Returns:



93
 
# File 'lib/generated/gobl/org/party.rb', line 93

property :meta, GOBL::CBC::Meta

#name ⇒ String (readonly)

Legal name or representation of the organization.

Returns:

  • (String) 


28
 
# File 'lib/generated/gobl/org/party.rb', line 28

property :name, String

#people ⇒ Array<GOBL::Org::Person> (readonly)

Details of physical people who represent the party.

Returns:



48
 
# File 'lib/generated/gobl/org/party.rb', line 48

property :people, [GOBL::Org::Person]

#registration ⇒ GOBL::Org::Registration (readonly)

Additional registration details about the company that may need to be included in a document.

Returns:



78
 
# File 'lib/generated/gobl/org/party.rb', line 78

property :registration, GOBL::Org::Registration

#tax_id ⇒ GOBL::Tax::Identity (readonly)

The entity’s legal ID code used for tax purposes. They may have other numbers, but we’re only interested in those valid for tax purposes.

Returns:



38
 
# File 'lib/generated/gobl/org/party.rb', line 38

property :tax_id, GOBL::Tax::Identity

#telephones ⇒ Array<GOBL::Org::Telephone> (readonly)

Regular telephone numbers

Returns:



73
 
# File 'lib/generated/gobl/org/party.rb', line 73

property :telephones, [GOBL::Org::Telephone]

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


18
 
# File 'lib/generated/gobl/org/party.rb', line 18

property :uuid, String

#websites ⇒ Array<GOBL::Org::Website> (readonly)

Public websites that provide further information about the party.

Returns:



68
 
# File 'lib/generated/gobl/org/party.rb', line 68

property :websites, [GOBL::Org::Website]