Class: ModernTreasury::Models::InvoiceCreateParams::CounterpartyBillingAddress

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/invoice_create_params.rb,
sig/modern_treasury/models/invoice_create_params.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(counterparty_id:, due_date:, originating_account_id:, auto_advance: nil, contact_details: nil, counterparty_billing_address: nil, counterparty_shipping_address: nil, currency: nil, description: nil, fallback_payment_method: nil, invoice_line_items: nil, invoicer_address: nil, invoicer_name: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, virtual_account_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::InvoiceCreateParams for more details.

Parameters:

  • counterparty_id (String) —

    The ID of the counterparty receiving the invoice.

  • due_date (Time) —

    A future date by when the invoice needs to be paid.

  • originating_account_id (String) —

    The ID of the internal account the invoice should be paid to.

  • auto_advance (Boolean, nil) (defaults to: nil) —

    When true, the invoice will progress to unpaid automatically and cannot be edite

  • contact_details (Array<ModernTreasury::Models::ContactDetail>) (defaults to: nil) —

    The invoicer's contact details displayed at the top of the invoice.

  • counterparty_billing_address (ModernTreasury::Models::InvoiceCreateParams::CounterpartyBillingAddress, nil) (defaults to: nil) —

    The counterparty's billing address.

  • counterparty_shipping_address (ModernTreasury::Models::InvoiceCreateParams::CounterpartyShippingAddress, nil) (defaults to: nil) —

    The counterparty's shipping address where physical goods should be delivered.

  • currency (Symbol, ModernTreasury::Models::Currency) (defaults to: nil) —

    Currency that the invoice is denominated in. Defaults to USD if not provided.

  • description (String) (defaults to: nil) —

    A free-form description of the invoice.

  • fallback_payment_method (String, nil) (defaults to: nil) —

    When payment_method is automatic, the fallback payment method to use when an aut

  • invoice_line_items (Array<ModernTreasury::Models::InvoiceCreateParams::InvoiceLineItem>, nil) (defaults to: nil) —

    An array of invoice line items. The API supports a maximum of 50 invoice line it

  • invoicer_address (ModernTreasury::Models::InvoiceCreateParams::InvoicerAddress, nil) (defaults to: nil) —

    The invoice issuer's business address.

  • invoicer_name (String, nil) (defaults to: nil) —

    The name of the issuer for the invoice. Defaults to the name of the Organization

  • metadata (Hash{Symbol=>String}, nil) (defaults to: nil) —

    Additional data represented as key-value pairs. Both the key and value must be s

  • notification_email_addresses (Array<String>, nil) (defaults to: nil) —

    Emails in addition to the counterparty email to send invoice status notification

  • notifications_enabled (Boolean) (defaults to: nil) —

    If true, the invoice will send email notifications to the invoice recipients abo

  • payment_effective_date (Date) (defaults to: nil) —

    Date transactions are to be posted to the participants' account. Defaults to the

  • payment_method (Symbol, ModernTreasury::Models::InvoiceCreateParams::PaymentMethod) (defaults to: nil) —

    The method by which the invoice can be paid. ui will show the embedded payment

  • payment_type (Symbol, ModernTreasury::Models::PaymentOrderType) (defaults to: nil) —

    One of ach, se_bankgirot, eft, wire, check, book, rtp, sepa, `ba

  • receiving_account_id (String) (defaults to: nil) —

    The receiving account ID. Can be an external_account.

  • recipient_email (String, nil) (defaults to: nil) —

    The email of the recipient of the invoice. Leaving this value as null will fallb

  • recipient_name (String, nil) (defaults to: nil) —

    The name of the recipient of the invoice. Leaving this value as null will fallba

  • remind_after_overdue_days (Array<Integer>, nil) (defaults to: nil) —

    Number of days after due date when overdue reminder emails will be sent out to i

  • virtual_account_id (String, nil) (defaults to: nil) —

    The ID of the virtual account the invoice should be paid to.

  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/modern_treasury/models/invoice_create_params.rb', line 237

class CounterpartyBillingAddress < ModernTreasury::Internal::Type::BaseModel
  # @!attribute country
  #   Country code conforms to [ISO 3166-1 alpha-2]
  #
  #   @return [String]
  required :country, String

  # @!attribute line1
  #
  #   @return [String]
  required :line1, String

  # @!attribute locality
  #   Locality or City.
  #
  #   @return [String]
  required :locality, String

  # @!attribute postal_code
  #   The postal code of the address.
  #
  #   @return [String]
  required :postal_code, String

  # @!attribute region
  #   Region or State.
  #
  #   @return [String]
  required :region, String

  # @!attribute line2
  #
  #   @return [String, nil]
  optional :line2, String

  # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
  #   The counterparty's billing address.
  #
  #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
  #
  #   @param line1 [String]
  #
  #   @param locality [String] Locality or City.
  #
  #   @param postal_code [String] The postal code of the address.
  #
  #   @param region [String] Region or State.
  #
  #   @param line2 [String]
end

Instance Attribute Details

#country ⇒ String

Country code conforms to [ISO 3166-1 alpha-2]

Parameters:

  • value (String)

Returns:

  • (String) 


242
 
# File 'lib/modern_treasury/models/invoice_create_params.rb', line 242

required :country, String

#line1 ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


247
 
# File 'lib/modern_treasury/models/invoice_create_params.rb', line 247

required :line1, String

#line2 ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


270
 
# File 'lib/modern_treasury/models/invoice_create_params.rb', line 270

optional :line2, String

#locality ⇒ String

Locality or City.

Parameters:

  • value (String)

Returns:

  • (String) 


253
 
# File 'lib/modern_treasury/models/invoice_create_params.rb', line 253

required :locality, String

#postal_code ⇒ String

The postal code of the address.

Parameters:

  • value (String)

Returns:

  • (String) 


259
 
# File 'lib/modern_treasury/models/invoice_create_params.rb', line 259

required :postal_code, String

#region ⇒ String

Region or State.

Parameters:

  • value (String)

Returns:

  • (String) 


265
 
# File 'lib/modern_treasury/models/invoice_create_params.rb', line 265

required :region, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


198
 
# File 'sig/modern_treasury/models/invoice_create_params.rbs', line 198

def to_hash: -> {