gobl 0.22.0 → 0.23.0

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

@@ -10,27 +10,72 @@ module GOBL
     # LineCharge represents an amount added to the line, and will be applied before taxes.
     class LineCharge < GOBL::Object
       # The Schema ID of the GOBL LineCharge structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/LineCharge'
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/line#/$defs/LineCharge'
+
+      # Enumeration of possible values for {#key} with their corresponding descriptions
+      KEY_ENUM = {
+        'stamp-duty' => 'Stamp Duty',
+        'outlay' => 'Outlay',
+        'tax' => 'Tax',
+        'customs' => 'Customs',
+        'delivery' => 'Delivery',
+        'packing' => 'Packing',
+        'handling' => 'Handling',
+        'insurance' => 'Insurance',
+        'storage' => 'Storage',
+        'admin' => 'Administration',
+        'cleaning' => 'Cleaning'
+      }.freeze
+
+      # @!attribute [r] key
+      # Key for grouping or identifying charges for tax purposes. A suggested list of keys is provided, but these are for reference only and may be extended by the issuer.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+
+      # @!attribute [r] code
+      # Reference or ID for this charge defined by the issuer
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+
+      # @!attribute [r] reason
+      # Text description as to why the charge was applied
+      # @return [String]
+      property :reason, String
+
+      # @!attribute [r] base
+      # Base for percent calculations instead of the line's sum
+      # @return [GOBL::Num::Amount]
+      property :base, GOBL::Num::Amount
 
       # @!attribute [r] percent
-      # Percentage if fixed amount not applied
+      # Percentage of base or parent line's sum
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
 
+      # @!attribute [r] quantity
+      # Quantity of units to apply the charge to when using the rate instead of the line's quantity.
+      # @return [GOBL::Num::Amount]
+      property :quantity, GOBL::Num::Amount
+
+      # @!attribute [r] unit
+      # Unit to associate with the quantity when using the rate.
+      # @return [GOBL::Org::Unit]
+      property :unit, GOBL::Org::Unit
+
+      # @!attribute [r] rate
+      # Rate defines a price per unit to use instead of the percentage.
+      # @return [GOBL::Num::Amount]
+      property :rate, GOBL::Num::Amount
+
       # @!attribute [r] amount
       # Fixed or resulting charge amount to apply (calculated if percent present).
       # @return [GOBL::Num::Amount]
       property :amount, GOBL::Num::Amount
 
-      # @!attribute [r] code
-      # Reference code.
-      # @return [String]
-      property :code, String
-
-      # @!attribute [r] reason
-      # Text description as to why the charge was applied
-      # @return [String]
-      property :reason, String
+      # @!attribute [r] ext
+      # Extension codes that apply to the charge
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
     end
   end
 end

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

@@ -10,27 +10,60 @@ module GOBL
     # LineDiscount represents an amount deducted from the line, and will be applied before taxes.
     class LineDiscount < GOBL::Object
       # The Schema ID of the GOBL LineDiscount structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/LineDiscount'
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/line#/$defs/LineDiscount'
 
-      # @!attribute [r] percent
-      # Percentage if fixed amount not applied
-      # @return [GOBL::Num::Percentage]
-      property :percent, GOBL::Num::Percentage
+      # Enumeration of possible values for {#key} with their corresponding descriptions
+      KEY_ENUM = {
+        'early-completion' => 'Bonus for works ahead of schedule',
+        'military' => 'Military Discount',
+        'work-accident' => 'Work Accident Discount',
+        'special-agreement' => 'Special Agreement Discount',
+        'production-error' => 'Production Error Discount',
+        'new-outlet' => 'New Outlet Discount',
+        'sample' => 'Sample Discount',
+        'end-of-range' => 'End of Range Discount',
+        'incoterm' => 'Incoterm Discount',
+        'pos-threshold' => 'Point of Sale Threshold Discount',
+        'special-rebate' => 'Special Rebate',
+        'temporary' => 'Temporary',
+        'standard' => 'Standard',
+        'yearly-turnover' => 'Yearly Turnover'
+      }.freeze
 
-      # @!attribute [r] amount
-      # Fixed discount amount to apply (calculated if percent present).
-      # @return [GOBL::Num::Amount]
-      property :amount, GOBL::Num::Amount
+      # @!attribute [r] key
+      # Key for identifying the type of discount being applied.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
 
       # @!attribute [r] code
-      # Reason code.
-      # @return [String]
-      property :code, String
+      # Code or reference for this discount defined by the issuer
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
 
       # @!attribute [r] reason
       # Text description as to why the discount was applied
       # @return [String]
       property :reason, String
+
+      # @!attribute [r] base
+      # Base for percent calculations instead of the line's sum.
+      # @return [GOBL::Num::Amount]
+      property :base, GOBL::Num::Amount
+
+      # @!attribute [r] percent
+      # Percentage to apply to the base or line sum to calculate the discount amount
+      # @return [GOBL::Num::Percentage]
+      property :percent, GOBL::Num::Percentage
+
+      # @!attribute [r] amount
+      # Fixed discount amount to apply (calculated if percent present)
+      # @return [GOBL::Num::Amount]
+      property :amount, GOBL::Num::Amount
+
+      # @!attribute [r] ext
+      # Extension codes that apply to the discount
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
     end
   end
 end

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

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Bill
+    # Order documents are used for the initial part of a order-to-invoice process where the buyer requests goods or services from the seller.
+    class Order < GOBL::Object
+      # The Schema ID of the GOBL Order structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/order'
+
+      # Enumeration of possible values for {#$regime} with their corresponding descriptions
+      $REGIME_ENUM = {
+        'AE' => 'United Arab Emirates',
+        'AT' => 'Austria',
+        'BE' => 'Belgium',
+        'BR' => 'Brazil',
+        'CA' => 'Canada',
+        'CH' => 'Switzerland',
+        'CO' => 'Colombia',
+        'DE' => 'Germany',
+        'EL' => 'Greece',
+        'ES' => 'Spain',
+        'FR' => 'France',
+        'GB' => 'United Kingdom',
+        'IN' => 'India',
+        'IT' => 'Italy',
+        'MX' => 'Mexico',
+        'NL' => 'The Netherlands',
+        'PL' => 'Poland',
+        'PT' => 'Portugal',
+        'US' => 'United States of America'
+      }.freeze
+
+      # @!attribute [r] $regime
+      # @return [GOBL::L10n::TaxCountryCode]
+      property :$regime, GOBL::L10n::TaxCountryCode
+      validates_inclusion_of :$regime, in: $REGIME_ENUM.keys, allow_blank: true
+
+      # @!attribute [r] $addons
+      # Addons defines a list of keys used to identify tax addons that apply special normalization, scenarios, and validation rules to a document.
+      # @return [Array<GOBL::CBC::Key>]
+      property :$addons, [GOBL::CBC::Key]
+
+      # @!attribute [r] $tags
+      # Tags are used to help identify specific tax scenarios or requirements that will apply changes to the contents of the invoice. Tags by design should always be optional, it should always be possible to build a valid invoice without any tags.
+      # @return [Array<GOBL::CBC::Key>]
+      property :$tags, [GOBL::CBC::Key]
+
+      # @!attribute [r] uuid
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # Enumeration of possible values for {#type} with their corresponding descriptions
+      TYPE_ENUM = {
+        'purchase' => 'A purchase order is a document that a buyer sends to a seller to request goods or services.',
+        'sale' => 'A sales order is a document that a seller sends to a buyer to confirm the sale of goods or services.',
+        'quote' => 'A quote is a document that a seller sends to a buyer to provide a price for goods or services.'
+      }.freeze
+
+      # @!attribute [r] type
+      # Type of the order.
+      # @return [GOBL::CBC::Key]
+      property :type, GOBL::CBC::Key
+      validates_inclusion_of :type, in: TYPE_ENUM.keys, allow_blank: true
+
+      # @!attribute [r] series
+      # Series is used to identify groups of orders by date, business area, project, type, customer, a combination of any, or other company specific data. If the output format does not support the series as a separate field, it will be prepended to the code for presentation with a dash (`-`) for separation.
+      # @return [GOBL::CBC::Code]
+      property :series, GOBL::CBC::Code
+
+      # @!attribute [r] code
+      # Code is a sequential identifier that uniquely identifies the order. The code can be left empty initially, but is **required** to **sign** the document.
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+
+      # @!attribute [r] issue_date
+      # When the invoice was created.
+      # @return [GOBL::Cal::Date]
+      property :issue_date, GOBL::Cal::Date
+
+      # @!attribute [r] issue_time
+      # IssueTime is an optional field that may be useful to indicate the time of day when the order was issued. Some regions and formats may require this field to be set. An empty string will be automatically updated to reflect the current time, otherwise the field can be left with a nil value.
+      # @return [GOBL::Cal::Time]
+      property :issue_time, GOBL::Cal::Time
+
+      # @!attribute [r] op_date
+      # Date when the operation defined by the invoice became effective.
+      # @return [GOBL::Cal::Date]
+      property :op_date, GOBL::Cal::Date
+
+      # @!attribute [r] value_date
+      # When the taxes of this invoice become accountable, if none set, the issue date is used.
+      # @return [GOBL::Cal::Date]
+      property :value_date, GOBL::Cal::Date
+
+      # @!attribute [r] currency
+      # Currency for all invoice totals.
+      # @return [GOBL::Currency::Code]
+      property :currency, GOBL::Currency::Code
+
+      # @!attribute [r] exchange_rates
+      # Exchange rates to be used when converting the invoices monetary values into other currencies.
+      # @return [Array<GOBL::Currency::ExchangeRate>]
+      property :exchange_rates, [GOBL::Currency::ExchangeRate]
+
+      # @!attribute [r] contracts
+      # The identification of contracts.
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :contracts, [GOBL::Org::DocumentRef]
+
+      # @!attribute [r] preceding
+      # Key information regarding previous order documents.
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :preceding, [GOBL::Org::DocumentRef]
+
+      # @!attribute [r] identities
+      # Additional codes, IDs, SKUs, or other regional or custom identifiers that may be used to identify the order.
+      # @return [Array<GOBL::Org::Identity>]
+      property :identities, [GOBL::Org::Identity]
+
+      # @!attribute [r] period
+      # Period of time in which the order is valid.
+      # @return [GOBL::Cal::Period]
+      property :period, GOBL::Cal::Period
+
+      # @!attribute [r] tax
+      # Special tax configuration for billing.
+      # @return [GOBL::Bill::Tax]
+      property :tax, GOBL::Bill::Tax
+
+      # @!attribute [r] supplier
+      # The entity supplying the goods or services and usually responsible for paying taxes.
+      # @return [GOBL::Org::Party]
+      property :supplier, GOBL::Org::Party
+      validates_presence_of :supplier
+
+      # @!attribute [r] customer
+      # Legal entity receiving the goods or services, may be nil in certain circumstances such as simplified invoices.
+      # @return [GOBL::Org::Party]
+      property :customer, GOBL::Org::Party
+
+      # @!attribute [r] buyer
+      # Party who is responsible for issuing payment, if not the same as the customer.
+      # @return [GOBL::Org::Party]
+      property :buyer, GOBL::Org::Party
+
+      # @!attribute [r] seller
+      # Seller is the party liable to pay taxes on the transaction if not the same as the supplier.
+      # @return [GOBL::Org::Party]
+      property :seller, GOBL::Org::Party
+
+      # @!attribute [r] lines
+      # List of lines representing each of the items to be ordered.
+      # @return [Array<GOBL::Bill::Line>]
+      property :lines, [GOBL::Bill::Line]
+
+      # @!attribute [r] discounts
+      # Discounts or allowances applied to order totals
+      # @return [Array<GOBL::Bill::Discount>]
+      property :discounts, [GOBL::Bill::Discount]
+
+      # @!attribute [r] charges
+      # Charges or surcharges applied to order totals
+      # @return [Array<GOBL::Bill::Charge>]
+      property :charges, [GOBL::Bill::Charge]
+
+      # @!attribute [r] payment
+      # Information on when, how, and to whom a final invoice would be paid.
+      # @return [GOBL::Bill::PaymentDetails]
+      property :payment, GOBL::Bill::PaymentDetails
+
+      # @!attribute [r] delivery
+      # Specific details on delivery of the goods to copy to the final invoice.
+      # @return [GOBL::Bill::DeliveryDetails]
+      property :delivery, GOBL::Bill::DeliveryDetails
+
+      # @!attribute [r] totals
+      # Summary of all the order totals, including taxes (calculated).
+      # @return [GOBL::Bill::Totals]
+      property :totals, GOBL::Bill::Totals
+
+      # @!attribute [r] notes
+      # Unstructured information that is relevant to the order, such as correction or additional legal details.
+      # @return [Array<GOBL::Org::Note>]
+      property :notes, [GOBL::Org::Note]
+
+      # @!attribute [r] complements
+      # Additional complementary objects that add relevant information to the order.
+      # @return [Array<GOBL::Schema::Object>]
+      property :complements, [GOBL::Schema::Object]
+
+      # @!attribute [r] meta
+      # Additional semi-structured data that doesn't fit into the body of the order.
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
+
+      # @!attribute [r] attachments
+      # Attachments provide additional information or supporting documents that are not included in the main document. It is important that attachments are not used for alternative versions of the PDF, for that, see "links" inside the envelope headers.
+      # @return [Array<GOBL::Org::Attachment>]
+      property :attachments, [GOBL::Org::Attachment]
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module GOBL
     # Ordering provides additional information about the ordering process including references to other documents and alternative parties involved in the order-to-delivery process.
     class Ordering < GOBL::Object
       # The Schema ID of the GOBL Ordering structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Ordering'
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/ordering'
 
       # @!attribute [r] code
       # Identifier assigned by the customer or buyer for internal routing purposes.
@@ -22,18 +22,23 @@ module GOBL
       # @return [Array<GOBL::Org::Identity>]
       property :identities, [GOBL::Org::Identity]
 
+      # @!attribute [r] cost
+      # Buyer accounting reference cost code associated with the document.
+      # @return [GOBL::CBC::Code]
+      property :cost, GOBL::CBC::Code
+
       # @!attribute [r] period
       # Period of time that the invoice document refers to often used in addition to the details provided in the individual line items.
       # @return [GOBL::Cal::Period]
       property :period, GOBL::Cal::Period
 
       # @!attribute [r] buyer
-      # Party who is responsible for making the purchase, but is not responsible for handling taxes.
+      # Party who is responsible for issuing payment, if not the same as the customer.
       # @return [GOBL::Org::Party]
       property :buyer, GOBL::Org::Party
 
       # @!attribute [r] seller
-      # Party who is selling the goods but is not responsible for taxes like the supplier.
+      # Seller is the party liable to pay taxes on the transaction if not the same as the supplier.
       # @return [GOBL::Org::Party]
       property :seller, GOBL::Org::Party
 

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

@@ -7,30 +7,170 @@
 
 module GOBL
   module Bill
-    # Payment contains details as to how the invoice should be paid.
+    # A Payment is used to link an invoice or invoices with a payment transaction.
     class Payment < GOBL::Object
       # The Schema ID of the GOBL Payment structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Payment'
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/payment'
+
+      # Enumeration of possible values for {#$regime} with their corresponding descriptions
+      $REGIME_ENUM = {
+        'AE' => 'United Arab Emirates',
+        'AT' => 'Austria',
+        'BE' => 'Belgium',
+        'BR' => 'Brazil',
+        'CA' => 'Canada',
+        'CH' => 'Switzerland',
+        'CO' => 'Colombia',
+        'DE' => 'Germany',
+        'EL' => 'Greece',
+        'ES' => 'Spain',
+        'FR' => 'France',
+        'GB' => 'United Kingdom',
+        'IN' => 'India',
+        'IT' => 'Italy',
+        'MX' => 'Mexico',
+        'NL' => 'The Netherlands',
+        'PL' => 'Poland',
+        'PT' => 'Portugal',
+        'US' => 'United States of America'
+      }.freeze
+
+      # @!attribute [r] $regime
+      # @return [GOBL::L10n::TaxCountryCode]
+      property :$regime, GOBL::L10n::TaxCountryCode
+      validates_inclusion_of :$regime, in: $REGIME_ENUM.keys, allow_blank: true
+
+      # @!attribute [r] $addons
+      # Addons defines a list of keys used to identify tax addons that apply special normalization, scenarios, and validation rules to a document.
+      # @return [Array<GOBL::CBC::Key>]
+      property :$addons, [GOBL::CBC::Key]
+
+      # @!attribute [r] $tags
+      # Tags are used to help identify specific tax scenarios or requirements that will apply changes to the contents of the invoice. Tags by design should always be optional, it should always be possible to build a valid invoice without any tags.
+      # @return [Array<GOBL::CBC::Key>]
+      property :$tags, [GOBL::CBC::Key]
+
+      # @!attribute [r] uuid
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # Enumeration of possible values for {#type} with their corresponding descriptions
+      TYPE_ENUM = {
+        'request' => 'A payment request sent from the supplier to a customer indicating that they are
+      requesting a transfer of funds from the customer directly or a payer.
+      This is used to request payment for specific documents and invoices.',
+        'advice' => 'A remittance advice sent from the customer to the supplier reflecting that payment for
+      the referenced documents has been made.',
+        'receipt' => 'A payment receipt sent from the supplier to a customer indicating that they have
+      received a transfer of funds from the customer directly or a payer.
+      This is the default payment type and may be required by some tax
+      regimes in order to communicate the payment of specific documents and invoices.'
+      }.freeze
+
+      # @!attribute [r] type
+      # Type of payment document being issued.
+      # @return [GOBL::CBC::Key]
+      property :type, GOBL::CBC::Key
+      validates_inclusion_of :type, in: TYPE_ENUM.keys, allow_blank: true
+
+      # @!attribute [r] method
+      # Details on how the payment was made based on the original instructions.
+      # @return [GOBL::Pay::Instructions]
+      property :method, GOBL::Pay::Instructions
+
+      # @!attribute [r] series
+      # Series is used to identify groups of payments by date, business area, project, type, customer, a combination of any, or other company specific data. If the output format does not support the series as a separate field, it will be prepended to the code for presentation with a dash (`-`) for separation.
+      # @return [GOBL::CBC::Code]
+      property :series, GOBL::CBC::Code
+
+      # @!attribute [r] code
+      # Code is a sequential identifier that uniquely identifies the payment. The code can be left empty initially, but is **required** to **sign** the document.
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+
+      # @!attribute [r] issue_date
+      # When the payment was issued.
+      # @return [GOBL::Cal::Date]
+      property :issue_date, GOBL::Cal::Date
+
+      # @!attribute [r] issue_time
+      # IssueTime is an optional field that may be useful to indicate the time of day when the payment was issued.
+      # @return [GOBL::Cal::Time]
+      property :issue_time, GOBL::Cal::Time
+
+      # @!attribute [r] value_date
+      # When the taxes of this payment become accountable, if none set, the issue date is assumed.
+      # @return [GOBL::Cal::Date]
+      property :value_date, GOBL::Cal::Date
+
+      # @!attribute [r] currency
+      # Currency for all payment totals.
+      # @return [GOBL::Currency::Code]
+      property :currency, GOBL::Currency::Code
+
+      # @!attribute [r] exchange_rates
+      # Exchange rates to be used when converting the payment's monetary values into other currencies.
+      # @return [Array<GOBL::Currency::ExchangeRate>]
+      property :exchange_rates, [GOBL::Currency::ExchangeRate]
+
+      # @!attribute [r] ext
+      # Extensions for additional codes that may be required.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
+
+      # @!attribute [r] preceding
+      # Key information regarding previous versions of this document.
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :preceding, [GOBL::Org::DocumentRef]
+
+      # @!attribute [r] supplier
+      # The taxable entity who is responsible for supplying goods or services.
+      # @return [GOBL::Org::Party]
+      property :supplier, GOBL::Org::Party
+      validates_presence_of :supplier
+
+      # @!attribute [r] customer
+      # Legal entity that receives the goods or services.
+      # @return [GOBL::Org::Party]
+      property :customer, GOBL::Org::Party
 
       # @!attribute [r] payee
-      # The party responsible for receiving payment of the invoice, if not the supplier.
+      # Legal entity that receives the payment if not the supplier.
       # @return [GOBL::Org::Party]
       property :payee, GOBL::Org::Party
 
-      # @!attribute [r] terms
-      # Payment terms or conditions.
-      # @return [GOBL::Pay::Terms]
-      property :terms, GOBL::Pay::Terms
+      # @!attribute [r] lines
+      # List of documents that are being paid for.
+      # @return [Array<PaymentLine>]
+      property :lines, [PaymentLine]
+      validates_presence_of :lines
 
-      # @!attribute [r] advances
-      # Any amounts that have been paid in advance and should be deducted from the amount due.
-      # @return [Array<GOBL::Pay::Advance>]
-      property :advances, [GOBL::Pay::Advance]
+      # @!attribute [r] ordering
+      # Ordering allows for additional information about the ordering process including references to other documents and alternative parties involved in the order-to-delivery process.
+      # @return [GOBL::Bill::Ordering]
+      property :ordering, GOBL::Bill::Ordering
 
-      # @!attribute [r] instructions
-      # Details on how payment should be made.
-      # @return [GOBL::Pay::Instructions]
-      property :instructions, GOBL::Pay::Instructions
+      # @!attribute [r] total
+      # Total amount to be paid in this payment, either positive or negative according to the line types and totals. Calculated automatically.
+      # @return [GOBL::Num::Amount]
+      property :total, GOBL::Num::Amount
+      validates_presence_of :total
+
+      # @!attribute [r] notes
+      # Unstructured information that is relevant to the payment, such as correction or additional legal details.
+      # @return [Array<GOBL::Org::Note>]
+      property :notes, [GOBL::Org::Note]
+
+      # @!attribute [r] complements
+      # Additional complementary objects that add relevant information to the payment.
+      # @return [Array<GOBL::Schema::Object>]
+      property :complements, [GOBL::Schema::Object]
+
+      # @!attribute [r] meta
+      # Additional semi-structured data that doesn't fit into the body of the invoice.
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
     end
   end
 end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Bill
+    # PaymentDetails contains details as to how the invoice should be paid.
+    class PaymentDetails < GOBL::Object
+      # The Schema ID of the GOBL PaymentDetails structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/payment-details'
+
+      # @!attribute [r] payee
+      # The party responsible for receiving payment of the invoice, if not the supplier.
+      # @return [GOBL::Org::Party]
+      property :payee, GOBL::Org::Party
+
+      # @!attribute [r] terms
+      # Payment terms or conditions.
+      # @return [GOBL::Pay::Terms]
+      property :terms, GOBL::Pay::Terms
+
+      # @!attribute [r] advances
+      # Any amounts that have been paid in advance and should be deducted from the amount due.
+      # @return [Array<GOBL::Pay::Advance>]
+      property :advances, [GOBL::Pay::Advance]
+
+      # @!attribute [r] instructions
+      # Details on how payment should be made.
+      # @return [GOBL::Pay::Instructions]
+      property :instructions, GOBL::Pay::Instructions
+    end
+  end
+end