gobl 0.22.0 → 0.23.0

data/lib/generated/gobl/bill/payment_line.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Bill
+    # PaymentLine defines the details of a line item in a payment document.
+    class PaymentLine < GOBL::Object
+      # The Schema ID of the GOBL PaymentLine structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/payment#/$defs/PaymentLine'
+
+      # @!attribute [r] uuid
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # @!attribute [r] i
+      # Line number within the parent document (automatically calculated)
+      # @return [Integer]
+      property :i, Integer
+
+      # @!attribute [r] refund
+      # Indicates whether this payment is a refund of a previous payment, effectively reversing the flow of funds between the supplier and customer or their representatives.
+      # @return [Boolean]
+      property :refund, Boolean
+
+      # @!attribute [r] document
+      # Reference to the document being paid
+      # @return [GOBL::Org::DocumentRef]
+      property :document, GOBL::Org::DocumentRef
+
+      # @!attribute [r] installment
+      # When making multiple payments for a single document, this specifies the installment number for this payment line.
+      # @return [Integer]
+      property :installment, Integer
+
+      # @!attribute [r] description
+      # Additional human readable description of the payment line which may be useful for explaining the purpose or special conditions. Notes should be used for more formal comments.
+      # @return [String]
+      property :description, String
+
+      # @!attribute [r] payable
+      # Payable reflects the amount of the document that is payable. This will be calculated from the embedded document's amount automatically and converted to the currency of the document.
+      # @return [GOBL::Num::Amount]
+      property :payable, GOBL::Num::Amount
+
+      # @!attribute [r] advances
+      # Amount already paid in previous installments, which may be required by some tax regimes or specific use cases.
+      # @return [GOBL::Num::Amount]
+      property :advances, GOBL::Num::Amount
+
+      # @!attribute [r] amount
+      # Amount of the total payment allocated to the referenced document.
+      # @return [GOBL::Num::Amount]
+      property :amount, GOBL::Num::Amount
+      validates_presence_of :amount
+
+      # @!attribute [r] due
+      # Due reflects how much still needs to be paid
+      # @return [GOBL::Num::Amount]
+      property :due, GOBL::Num::Amount
+
+      # @!attribute [r] tax
+      # Tax contains a breakdown of the taxes that will be applied to this payment line after taking into account currency conversion and the relative amounts.
+      # @return [GOBL::Tax::Total]
+      property :tax, GOBL::Tax::Total
+
+      # @!attribute [r] notes
+      # Additional notes specific to this line item for clarification purposes
+      # @return [Array<GOBL::Org::Note>]
+      property :notes, [GOBL::Org::Note]
+    end
+  end
+end

data/lib/generated/gobl/bill/sub_line.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Bill
+    # SubLine provides a simplified line that can be embedded inside other lines to provide a more detailed breakdown of the items being sold or substituted.
+    class SubLine < GOBL::Object
+      # The Schema ID of the GOBL SubLine structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/line#/$defs/SubLine'
+
+      # @!attribute [r] uuid
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # @!attribute [r] i
+      # Line number inside the parent (calculated)
+      # @return [Integer]
+      property :i, Integer
+
+      # @!attribute [r] quantity
+      # Number of items
+      # @return [GOBL::Num::Amount]
+      property :quantity, GOBL::Num::Amount
+      validates_presence_of :quantity
+
+      # @!attribute [r] identifier
+      # Single identifier provided by the supplier for an object on which the line item is based and is not considered a universal identity. Examples include a subscription number, telephone number, meter point, etc. Utilize the label property to provide a description of the identifier.
+      # @return [GOBL::Org::Identity]
+      property :identifier, GOBL::Org::Identity
+
+      # @!attribute [r] period
+      # A period of time relevant to when the service or item is delivered.
+      # @return [GOBL::Cal::Period]
+      property :period, GOBL::Cal::Period
+
+      # @!attribute [r] order
+      # Order reference for a specific line within a purchase order provided by the buyer.
+      # @return [GOBL::CBC::Code]
+      property :order, GOBL::CBC::Code
+
+      # @!attribute [r] cost
+      # Buyer accounting reference cost code to associate with the line.
+      # @return [GOBL::CBC::Code]
+      property :cost, GOBL::CBC::Code
+
+      # @!attribute [r] item
+      # Details about the item, service or good, that is being sold
+      # @return [GOBL::Org::Item]
+      property :item, GOBL::Org::Item
+      validates_presence_of :item
+
+      # @!attribute [r] sum
+      # Result of quantity multiplied by the item's price (calculated)
+      # @return [GOBL::Num::Amount]
+      property :sum, GOBL::Num::Amount
+
+      # @!attribute [r] discounts
+      # Discounts applied to this sub-line
+      # @return [Array<LineDiscount>]
+      property :discounts, [LineDiscount]
+
+      # @!attribute [r] charges
+      # Charges applied to this sub-line
+      # @return [Array<LineCharge>]
+      property :charges, [LineCharge]
+
+      # @!attribute [r] total
+      # Total sub-line amount after applying discounts to the sum (calculated).
+      # @return [GOBL::Num::Amount]
+      property :total, GOBL::Num::Amount
+
+      # @!attribute [r] notes
+      # Set of specific notes for this sub-line that may be required for clarification.
+      # @return [Array<GOBL::Org::Note>]
+      property :notes, [GOBL::Org::Note]
+    end
+  end
+end

data/lib/generated/gobl/bill/tax.rb

@@ -10,13 +10,32 @@ module GOBL
     # Tax defines a summary of the taxes which may be applied to an invoice.
     class Tax < GOBL::Object
       # The Schema ID of the GOBL Tax structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Tax'
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/tax'
 
       # @!attribute [r] prices_include
       # Category of the tax already included in the line item prices, especially useful for B2C retailers with customers who prefer final prices inclusive of tax.
       # @return [GOBL::CBC::Code]
       property :prices_include, GOBL::CBC::Code
 
+      # Enumeration of possible values for {#rounding} with their corresponding descriptions
+      ROUNDING_ENUM = {
+        'precise' => 'The default method of calculating the totals in GOBL, and provides the best results
+      for most cases as the precision is maintained to the maximum amount possible. The
+      tradeoff however is that sometimes the totals may not sum exactly based on what is visible.',
+        'currency' => 'The alternative method of calculating the totals that will first round all the amounts
+      to the currencys precision before making the sums. Totals using this approach can always
+      be recalculated using the amounts presented, but can lead to rounding errors in the case
+      of pre-payments and when line item prices include tax.s precision before making the sums. Totals using this approach can always
+      be recalculated using the amounts presented, but can lead to rounding errors in the case
+      of pre-payments and when line item prices include tax.'
+      }.freeze
+
+      # @!attribute [r] rounding
+      # Rounding model used to perform tax calculations on the invoice. This will be configured automatically based on the tax regime, or `sum-then-round` by default, but you can override here if needed. Use with caution, as some conversion tools may make assumptions about the rounding model used.
+      # @return [GOBL::CBC::Key]
+      property :rounding, GOBL::CBC::Key
+      validates_inclusion_of :rounding, in: ROUNDING_ENUM.keys, allow_blank: true
+
       # @!attribute [r] ext
       # Additional extensions that are applied to the invoice as a whole as opposed to specific sections.
       # @return [GOBL::Tax::Extensions]

data/lib/generated/gobl/bill/totals.rb

@@ -10,74 +10,74 @@ module GOBL
     # Totals contains the summaries of all calculations for the invoice.
     class Totals < GOBL::Object
       # The Schema ID of the GOBL Totals structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Totals'
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/totals'
 
       # @!attribute [r] sum
-      # Sum of all line item sums
+      # Total of all line item amounts.
       # @return [GOBL::Num::Amount]
       property :sum, GOBL::Num::Amount
       validates_presence_of :sum
 
       # @!attribute [r] discount
-      # Sum of all document level discounts
+      # Total of all discounts applied at the document level.
       # @return [GOBL::Num::Amount]
       property :discount, GOBL::Num::Amount
 
       # @!attribute [r] charge
-      # Sum of all document level charges
+      # Total of all charges applied at the document level.
       # @return [GOBL::Num::Amount]
       property :charge, GOBL::Num::Amount
 
       # @!attribute [r] tax_included
-      # If prices include tax, this is the total tax included in the price.
+      # Total tax amount included in the prices, if prices are tax-inclusive.
       # @return [GOBL::Num::Amount]
       property :tax_included, GOBL::Num::Amount
 
       # @!attribute [r] total
-      # Sum of all line sums minus the discounts, plus the charges, without tax.
+      # Net total amount after subtracting discounts and adding charges, excluding tax.
       # @return [GOBL::Num::Amount]
       property :total, GOBL::Num::Amount
       validates_presence_of :total
 
       # @!attribute [r] taxes
-      # Summary of all the taxes included in the invoice.
+      # Detailed breakdown of all taxes applied to the invoice.
       # @return [GOBL::Tax::Total]
       property :taxes, GOBL::Tax::Total
 
       # @!attribute [r] tax
-      # Total amount of tax to apply to the invoice.
+      # Total indirect tax amount to be applied to the invoice.
       # @return [GOBL::Num::Amount]
       property :tax, GOBL::Num::Amount
 
       # @!attribute [r] total_with_tax
-      # Grand total after all taxes have been applied.
+      # Final total amount after applying indirect taxes.
       # @return [GOBL::Num::Amount]
       property :total_with_tax, GOBL::Num::Amount
       validates_presence_of :total_with_tax
 
-      # @!attribute [r] rounding
-      # Rounding amount to apply to the invoice in case the total and payable amounts don't quite match.
+      # @!attribute [r] retained_tax
+      # Total tax amount retained or withheld by the customer to be paid to the tax authority.
       # @return [GOBL::Num::Amount]
-      property :rounding, GOBL::Num::Amount
+      property :retained_tax, GOBL::Num::Amount
 
-      # @!attribute [r] outlays
-      # Total paid in outlays that need to be reimbursed
+      # @!attribute [r] rounding
+      # Adjustment amount applied to the invoice totals to meet rounding rules or expectations.
       # @return [GOBL::Num::Amount]
-      property :outlays, GOBL::Num::Amount
+      property :rounding, GOBL::Num::Amount
 
       # @!attribute [r] payable
-      # Total amount to be paid after applying taxes and outlays.
+      # Final amount to be paid after retained taxes and rounding adjustments.
       # @return [GOBL::Num::Amount]
       property :payable, GOBL::Num::Amount
       validates_presence_of :payable
 
       # @!attribute [r] advance
-      # Total amount already paid in advance.
+      # Total amount already paid in advance by the customer.
       # @return [GOBL::Num::Amount]
       property :advance, GOBL::Num::Amount
 
       # @!attribute [r] due
-      # How much actually needs to be paid now.
+      # Remaining amount that needs to be paid.
       # @return [GOBL::Num::Amount]
       property :due, GOBL::Num::Amount
     end

data/lib/generated/gobl/bill/tracking.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Bill
+    # Tracking stores tracking information about a delivery.
+    class Tracking < GOBL::Object
+      # The Schema ID of the GOBL Tracking structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/delivery#/$defs/Tracking'
+
+      # @!attribute [r] code
+      # Code used for tracking
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+
+      # @!attribute [r] website
+      # Website to access for more tracking details
+      # @return [GOBL::Org::Website]
+      property :website, GOBL::Org::Website
+    end
+  end
+end

data/lib/generated/gobl/cal/date_time.rb

@@ -8,7 +8,7 @@
 module GOBL
   module Cal
     # Civil date time in simplified ISO format with no time zone
-    # information, for example: 2021-05-26T13:45:00
+    # nor location information, for example: 2021-05-26T13:45:00
     class DateTime < String
       # The Schema ID of the GOBL DateTime structure
       SCHEMA_ID = 'https://gobl.org/draft-0/cal/date-time'

data/lib/generated/gobl/cal/time.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Cal
+    # Civil time in simplified ISO format, like 13:45:30
+    class Time < String
+      # The Schema ID of the GOBL Time structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/cal/time'
+    end
+  end
+end

data/lib/generated/gobl/cbc/code.rb

@@ -7,7 +7,8 @@
 
 module GOBL
   module CBC
-    # Alphanumerical text identifier with upper-case letters, no whitespace, nor symbols.
+    # Alphanumerical text identifier with upper-case letters and limits on using
+    # special characters or whitespace to separate blocks.
     class Code < String
       # The Schema ID of the GOBL Code structure
       SCHEMA_ID = 'https://gobl.org/draft-0/cbc/code'

data/lib/generated/gobl/cbc/{key_definition.rb → definition.rb}

@@ -7,16 +7,20 @@
 
 module GOBL
   module CBC
-    # KeyDefinition defines properties of a key that is specific for a regime.
-    class KeyDefinition < GOBL::Object
-      # The Schema ID of the GOBL KeyDefinition structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/cbc/key-definition'
+    # Definition defines properties of a key, code, or other value that has a specific meaning or utility.
+    class Definition < GOBL::Object
+      # The Schema ID of the GOBL Definition structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/cbc/definition'
 
       # @!attribute [r] key
-      # Actual key value.
+      # Key being defined.
       # @return [GOBL::CBC::Key]
       property :key, GOBL::CBC::Key
-      validates_presence_of :key
+
+      # @!attribute [r] code
+      # Code this definition represents.
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
 
       # @!attribute [r] name
       # Short name for the key.
@@ -34,10 +38,15 @@ module GOBL
       # @return [GOBL::CBC::Meta]
       property :meta, GOBL::CBC::Meta
 
+      # @!attribute [r] sources
+      # Where the information was sourced from.
+      # @return [Array<GOBL::CBC::Source>]
+      property :sources, [GOBL::CBC::Source]
+
       # @!attribute [r] values
-      # Values defines the possible values associated with the key.
-      # @return [Array<GOBL::CBC::ValueDefinition>]
-      property :values, [GOBL::CBC::ValueDefinition]
+      # Values defines the possible values associated with the key, which themselves will either be keys or codes depending on the context.
+      # @return [Array<GOBL::CBC::Definition>]
+      property :values, [GOBL::CBC::Definition]
 
       # @!attribute [r] pattern
       # Pattern is used to validate the key value instead of using a fixed value from the code or key definitions.

data/lib/generated/gobl/cbc/source.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module CBC
+    # Source is used to identify a specific source of data.
+    class Source < GOBL::Object
+      # The Schema ID of the GOBL Source structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/cbc/source'
+
+      # @!attribute [r] title
+      # Title stores the name of the source of information.
+      # @return [GOBL::I18n::String]
+      property :title, GOBL::I18n::String
+
+      # @!attribute [r] url
+      # URL is the location of the source of information.
+      # @return [String]
+      property :url, String
+      validates_presence_of :url
+
+      # @!attribute [r] content_type
+      # ContentType of the information expected at the URL.
+      # @return [String]
+      property :content_type, String
+
+      # @!attribute [r] at
+      # At is the date and time the information was retrieved.
+      # @return [GOBL::Cal::DateTime]
+      property :at, GOBL::Cal::DateTime
+    end
+  end
+end

data/lib/generated/gobl/currency/code.rb

@@ -21,9 +21,14 @@ module GOBL
         'AUD' => 'Australian Dollar',
         'CAD' => 'Canadian Dollar',
         'JPY' => 'Japanese Yen',
-        'BYR' => 'Belarusian Ruble',
-        'MOP' => 'Macanese Pataca',
-        'HTG' => 'Haitian Gourde',
+        'AED' => 'United Arab Emirates Dirham',
+        'AFN' => 'Afghan Afghani',
+        'ALL' => 'Albanian Lek',
+        'AMD' => 'Armenian Dram',
+        'ANG' => 'Netherlands Antillean Gulden',
+        'AOA' => 'Angolan Kwanza',
+        'ARS' => 'Argentine Peso',
+        'AWG' => 'Aruban Florin',
         'AZN' => 'Azerbaijani Manat',
         'BAM' => 'Bosnia and Herzegovina Convertible Mark',
         'BBD' => 'Barbadian Dollar',
@@ -39,9 +44,8 @@ module GOBL
         'BTN' => 'Bhutanese Ngultrum',
         'BWP' => 'Botswana Pula',
         'BYN' => 'Belarusian Ruble',
-        'ARS' => 'Argentine Peso',
+        'BYR' => 'Belarusian Ruble',
         'BZD' => 'Belize Dollar',
-        'AOA' => 'Angolan Kwanza',
         'CDF' => 'Congolese Franc',
         'CHF' => 'Swiss Franc',
         'CLF' => 'Unidad de Fomento',
@@ -55,15 +59,13 @@ module GOBL
         'CZK' => 'Czech Koruna',
         'DJF' => 'Djiboutian Franc',
         'DKK' => 'Danish Krone',
-        'MXN' => 'Mexican Peso',
+        'DOP' => 'Dominican Peso',
         'DZD' => 'Algerian Dinar',
         'EGP' => 'Egyptian Pound',
         'ERN' => 'Eritrean Nakfa',
         'ETB' => 'Ethiopian Birr',
-        'ANG' => 'Netherlands Antillean Gulden',
         'FJD' => 'Fijian Dollar',
         'FKP' => 'Falkland Pound',
-        'AMD' => 'Armenian Dram',
         'GEL' => 'Georgian Lari',
         'GHS' => 'Ghanaian Cedi',
         'GIP' => 'Gibraltar Pound',
@@ -73,7 +75,7 @@ module GOBL
         'GYD' => 'Guyanese Dollar',
         'HKD' => 'Hong Kong Dollar',
         'HNL' => 'Honduran Lempira',
-        'MWK' => 'Malawian Kwacha',
+        'HTG' => 'Haitian Gourde',
         'HUF' => 'Hungarian Forint',
         'IDR' => 'Indonesian Rupiah',
         'ILS' => 'Israeli New Sheqel',
@@ -83,7 +85,6 @@ module GOBL
         'ISK' => 'Icelandic Króna',
         'JMD' => 'Jamaican Dollar',
         'JOD' => 'Jordanian Dinar',
-        'ALL' => 'Albanian Lek',
         'KES' => 'Kenyan Shilling',
         'KGS' => 'Kyrgyzstani Som',
         'KHR' => 'Cambodian Riel',
@@ -105,12 +106,12 @@ module GOBL
         'MKD' => 'Macedonian Denar',
         'MMK' => 'Myanmar Kyat',
         'MNT' => 'Mongolian Tögrög',
-        'AED' => 'United Arab Emirates Dirham',
+        'MOP' => 'Macanese Pataca',
         'MRU' => 'Mauritanian Ouguiya',
         'MUR' => 'Mauritian Rupee',
-        'PLN' => 'Polish Złoty',
-        'AWG' => 'Aruban Florin',
-        'DOP' => 'Dominican Peso',
+        'MVR' => 'Maldivian Rufiyaa',
+        'MWK' => 'Malawian Kwacha',
+        'MXN' => 'Mexican Peso',
         'MYR' => 'Malaysian Ringgit',
         'MZN' => 'Mozambican Metical',
         'NAD' => 'Namibian Dollar',
@@ -125,7 +126,7 @@ module GOBL
         'PGK' => 'Papua New Guinean Kina',
         'PHP' => 'Philippine Peso',
         'PKR' => 'Pakistani Rupee',
-        'MVR' => 'Maldivian Rufiyaa',
+        'PLN' => 'Polish Złoty',
         'PYG' => 'Paraguayan Guaraní',
         'QAR' => 'Qatari Riyal',
         'RON' => 'Romanian Leu',
@@ -161,7 +162,6 @@ module GOBL
         'TZS' => 'Tanzanian Shilling',
         'UAH' => 'Ukrainian Hryvnia',
         'UGX' => 'Ugandan Shilling',
-        'AFN' => 'Afghan Afghani',
         'UYU' => 'Uruguayan Peso',
         'UZS' => 'Uzbekistan Som',
         'VES' => 'Venezuelan Bolívar Soberano',

data/lib/generated/gobl/currency/exchange_rate.rb

@@ -24,16 +24,21 @@ module GOBL
       property :to, GOBL::Currency::Code
       validates_presence_of :to
 
+      # @!attribute [r] at
+      # At represents the effective date and time at which the exchange rate is determined by the source. The time may be zero if referring to a specific day only.
+      # @return [GOBL::Cal::DateTime]
+      property :at, GOBL::Cal::DateTime
+
+      # @!attribute [r] source
+      # Source key provides a reference to the source the exchange rate was obtained from. Typically this will be determined by an application used to update exchange rates automatically.
+      # @return [GOBL::CBC::Key]
+      property :source, GOBL::CBC::Key
+
       # @!attribute [r] amount
       # How much is 1 of the "from" currency worth in the "to" currency.
       # @return [GOBL::Num::Amount]
       property :amount, GOBL::Num::Amount
       validates_presence_of :amount
-
-      # @!attribute [r] at
-      # At represents the date and time (which may be 00:00:00) when the currency rate amount was determined.
-      # @return [GOBL::Cal::DateTime]
-      property :at, GOBL::Cal::DateTime
     end
   end
 end

data/lib/generated/gobl/org/address.rb

@@ -58,19 +58,24 @@ module GOBL
       property :street_extra, String
 
       # @!attribute [r] locality
-      # Village, town, district, or city, typically inside a region.
+      # Name of a village, town, district, or city, typically inside a region.
       # @return [String]
       property :locality, String
 
       # @!attribute [r] region
-      # Province, county, or state, inside a country.
+      # Name of a city, province, county, or state, inside a country.
       # @return [String]
       property :region, String
 
+      # @!attribute [r] state
+      # State or province code for countries that require it.
+      # @return [GOBL::CBC::Code]
+      property :state, GOBL::CBC::Code
+
       # @!attribute [r] code
       # Post or ZIP code.
-      # @return [String]
-      property :code, String
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
 
       # @!attribute [r] country
       # ISO country code.

data/lib/generated/gobl/org/attachment.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Org
+    # An Attachment provides a structure to be used to attach documents inside a GOBL document, either as a reference via a URL, or directly as a base64 encoded string.
+    class Attachment < GOBL::Object
+      # The Schema ID of the GOBL Attachment structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/attachment'
+
+      # @!attribute [r] uuid
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # @!attribute [r] key
+      # Key used to identify the attachment inside the document.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+
+      # @!attribute [r] code
+      # Code used to identify the payload of the attachment.
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+
+      # @!attribute [r] name
+      # Filename of the attachment.
+      # @return [String]
+      property :name, String
+      validates_presence_of :name
+
+      # @!attribute [r] description
+      # Details of why the attachment is being included and details on what it contains.
+      # @return [String]
+      property :description, String
+
+      # @!attribute [r] url
+      # URL of where to find the attachment. Prefer using this field over the Data field.
+      # @return [String]
+      property :url, String
+
+      # @!attribute [r] digest
+      # Digest is used to verify the integrity of the attachment when downloaded from the URL.
+      # @return [GOBL::DSig::Digest]
+      property :digest, GOBL::DSig::Digest
+
+      # @!attribute [r] mime
+      # MIME type of the attachment.
+      # @return [String]
+      property :mime, String
+
+      # @!attribute [r] data
+      # Data is the base64 encoded data of the attachment directly embedded inside the GOBL document. This should only be used when the URL cannot be used as it can dramatically increase the size of the JSON document, thus effecting usability and performance.
+      # @return [String]
+      property :data, String
+    end
+  end
+end