Class: GOBL::Cal::Period

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Cal::Period

Defined in:

lib/generated/gobl/cal/period.rb

Overview

Period represents two dates with a start and finish.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Period structure

'https://gobl.org/draft-0/cal/period'

Instance Attribute Summary

• #end ⇒ GOBL::Cal::Date readonly

  End indicates when the period ends, and must be after the start date.

• #label ⇒ String readonly

  Label is a short description of the period.

• #start ⇒ GOBL::Cal::Date readonly

  Start indicates when this period starts.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#end ⇒ GOBL::Cal::Date (readonly)

End indicates when the period ends, and must be after the start date.

Returns:

• (GOBL::Cal::Date)

# File 'lib/generated/gobl/cal/period.rb', line 29

property :end, GOBL::Cal::Date

#label ⇒ String (readonly)

Label is a short description of the period.

Returns:

• (String)

# File 'lib/generated/gobl/cal/period.rb', line 18

property :label, String

#start ⇒ GOBL::Cal::Date (readonly)

Start indicates when this period starts.

Returns:

• (GOBL::Cal::Date)

# File 'lib/generated/gobl/cal/period.rb', line 23

property :start, GOBL::Cal::Date