orb-billing 1.49.0 → 1.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +1 -1
- data/lib/orb/models/changed_subscription_resources.rb +21 -1
- data/lib/orb/models/customers/credit_fetch_balance_by_external_id_params.rb +31 -0
- data/lib/orb/models/customers/credit_fetch_balance_by_external_id_response.rb +61 -0
- data/lib/orb/models/customers/credit_fetch_balance_params.rb +31 -0
- data/lib/orb/models/customers/credit_fetch_balance_response.rb +60 -0
- data/lib/orb/models/invoice.rb +21 -1
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +21 -1
- data/lib/orb/models/invoice_issue_summary_response.rb +21 -1
- data/lib/orb/models/invoice_issued_summary_webhook_event.rb +21 -1
- data/lib/orb/models/invoice_list_summary_response.rb +21 -1
- data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +21 -1
- data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +21 -1
- data/lib/orb/resources/customers/credits.rb +76 -0
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +4 -0
- data/rbi/orb/models/changed_subscription_resources.rbi +24 -0
- data/rbi/orb/models/customers/credit_fetch_balance_by_external_id_params.rbi +54 -0
- data/rbi/orb/models/customers/credit_fetch_balance_by_external_id_response.rbi +86 -0
- data/rbi/orb/models/customers/credit_fetch_balance_params.rbi +54 -0
- data/rbi/orb/models/customers/credit_fetch_balance_response.rbi +86 -0
- data/rbi/orb/models/invoice.rbi +24 -0
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +24 -0
- data/rbi/orb/models/invoice_issue_summary_response.rbi +24 -0
- data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +24 -0
- data/rbi/orb/models/invoice_list_summary_response.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +24 -0
- data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +24 -0
- data/rbi/orb/resources/customers/credits.rbi +60 -0
- data/sig/orb/models/changed_subscription_resources.rbs +10 -0
- data/sig/orb/models/customers/credit_fetch_balance_by_external_id_params.rbs +30 -0
- data/sig/orb/models/customers/credit_fetch_balance_by_external_id_response.rbs +42 -0
- data/sig/orb/models/customers/credit_fetch_balance_params.rbs +30 -0
- data/sig/orb/models/customers/credit_fetch_balance_response.rbs +42 -0
- data/sig/orb/models/invoice.rbs +10 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +10 -0
- data/sig/orb/models/invoice_issue_summary_response.rbs +10 -0
- data/sig/orb/models/invoice_issued_summary_webhook_event.rbs +10 -0
- data/sig/orb/models/invoice_list_summary_response.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_edited_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_issued_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbs +10 -0
- data/sig/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbs +10 -0
- data/sig/orb/resources/customers/credits.rbs +12 -0
- metadata +13 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b13531cc7174792da0403fb24d8daaec0a7f4c506a99ea8f0fff3cb812f8ffd7
|
|
4
|
+
data.tar.gz: 392550e5d20269c44a509ddfd642ee9645bd2c8d71821d53b62d2f8aee0ee2c9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2b37f4211ac72f771577ef9ee4a58c6887f1a6d51595bfdc1638c70ab9d7db65041f965f65bd3fd25127079265b0c2c866c82916634b0cedb466def823c5f712
|
|
7
|
+
data.tar.gz: d9ff1ad381affb5d9cba1f8c96d253bc3318760f310e55e721755ec2b61e4b2d1144006889f27d2d66cfac234bc82b51667b53e79492171b7f8e599040c74e8b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.51.0](https://github.com/orbcorp/orb-ruby/compare/v1.50.0...v1.51.0) (2026-10-30)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **api:** api update ([01f12f2](https://github.com/orbcorp/orb-ruby/commit/01f12f276b97281beb60479d09992f5165dc24df))
|
|
9
|
+
|
|
10
|
+
## [1.50.0](https://github.com/orbcorp/orb-ruby/compare/v1.49.0...v1.50.0) (2026-10-29)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* **api:** api update ([b590f28](https://github.com/orbcorp/orb-ruby/commit/b590f28544e0267e1af12fbc9837b92e817243bc))
|
|
16
|
+
|
|
3
17
|
## [1.49.0](https://github.com/orbcorp/orb-ruby/compare/v1.48.0...v1.49.0) (2026-10-27)
|
|
4
18
|
|
|
5
19
|
|
data/README.md
CHANGED
|
@@ -425,6 +425,22 @@ module Orb
|
|
|
425
425
|
# @return [Time, nil]
|
|
426
426
|
required :scheduled_issue_at, Time, nil?: true
|
|
427
427
|
|
|
428
|
+
# @!attribute service_period_end
|
|
429
|
+
# The latest `end_date` of the invoice's line items, including any line items
|
|
430
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
431
|
+
# line items.
|
|
432
|
+
#
|
|
433
|
+
# @return [Time, nil]
|
|
434
|
+
required :service_period_end, Time, nil?: true
|
|
435
|
+
|
|
436
|
+
# @!attribute service_period_start
|
|
437
|
+
# The earliest `start_date` of the invoice's line items, including any line items
|
|
438
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
439
|
+
# line items.
|
|
440
|
+
#
|
|
441
|
+
# @return [Time, nil]
|
|
442
|
+
required :service_period_start, Time, nil?: true
|
|
443
|
+
|
|
428
444
|
# @!attribute shipping_address
|
|
429
445
|
#
|
|
430
446
|
# @return [Orb::Models::Address, nil]
|
|
@@ -474,7 +490,7 @@ module Orb
|
|
|
474
490
|
# @return [Boolean]
|
|
475
491
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
|
476
492
|
|
|
477
|
-
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, is_payable_now:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
493
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, is_payable_now:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
478
494
|
# Some parameter documentations has been truncated, see
|
|
479
495
|
# {Orb::Models::ChangedSubscriptionResources::CreatedInvoice} for more details.
|
|
480
496
|
#
|
|
@@ -550,6 +566,10 @@ module Orb
|
|
|
550
566
|
#
|
|
551
567
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
|
552
568
|
#
|
|
569
|
+
# @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
|
|
570
|
+
#
|
|
571
|
+
# @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
|
|
572
|
+
#
|
|
553
573
|
# @param shipping_address [Orb::Models::Address, nil]
|
|
554
574
|
#
|
|
555
575
|
# @param status [Symbol, Orb::Models::ChangedSubscriptionResources::CreatedInvoice::Status]
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
module Customers
|
|
6
|
+
# @see Orb::Resources::Customers::Credits#fetch_balance_by_external_id
|
|
7
|
+
class CreditFetchBalanceByExternalIDParams < Orb::Internal::Type::BaseModel
|
|
8
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Orb::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute external_customer_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :external_customer_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute currency
|
|
17
|
+
# The ledger currency or custom pricing unit to use.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :currency, String, nil?: true
|
|
21
|
+
|
|
22
|
+
# @!method initialize(external_customer_id:, currency: nil, request_options: {})
|
|
23
|
+
# @param external_customer_id [String]
|
|
24
|
+
#
|
|
25
|
+
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
|
26
|
+
#
|
|
27
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
module Customers
|
|
6
|
+
# @see Orb::Resources::Customers::Credits#fetch_balance_by_external_id
|
|
7
|
+
class CreditFetchBalanceByExternalIDResponse < Orb::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute balance
|
|
9
|
+
# The customer's available credit balance: the sum of `balance` across their
|
|
10
|
+
# `active` credit blocks.
|
|
11
|
+
#
|
|
12
|
+
# @return [Float]
|
|
13
|
+
required :balance, Float
|
|
14
|
+
|
|
15
|
+
# @!attribute currency
|
|
16
|
+
# The currency or custom pricing unit the balances are denominated in. Null when
|
|
17
|
+
# no `currency` is passed and the customer has no credit ledger, in which case
|
|
18
|
+
# every balance is `0`.
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
required :currency, String, nil?: true
|
|
22
|
+
|
|
23
|
+
# @!attribute next_expiry_balance
|
|
24
|
+
# The balance that expires on `next_expiry_date`. Null if `next_expiry_date` is
|
|
25
|
+
# null.
|
|
26
|
+
#
|
|
27
|
+
# @return [Float, nil]
|
|
28
|
+
required :next_expiry_balance, Float, nil?: true
|
|
29
|
+
|
|
30
|
+
# @!attribute next_expiry_date
|
|
31
|
+
# The earliest `expiry_date` among active credit blocks. Null if none of them
|
|
32
|
+
# expire.
|
|
33
|
+
#
|
|
34
|
+
# @return [Time, nil]
|
|
35
|
+
required :next_expiry_date, Time, nil?: true
|
|
36
|
+
|
|
37
|
+
# @!attribute pending_payment_balance
|
|
38
|
+
# The total balance of credit blocks in `pending_payment` status. Not included in
|
|
39
|
+
# `balance` until the invoice that funds them is paid.
|
|
40
|
+
#
|
|
41
|
+
# @return [Float]
|
|
42
|
+
required :pending_payment_balance, Float
|
|
43
|
+
|
|
44
|
+
# @!method initialize(balance:, currency:, next_expiry_balance:, next_expiry_date:, pending_payment_balance:)
|
|
45
|
+
# Some parameter documentations has been truncated, see
|
|
46
|
+
# {Orb::Models::Customers::CreditFetchBalanceByExternalIDResponse} for more
|
|
47
|
+
# details.
|
|
48
|
+
#
|
|
49
|
+
# @param balance [Float] The customer's available credit balance: the sum of `balance` across their `acti
|
|
50
|
+
#
|
|
51
|
+
# @param currency [String, nil] The currency or custom pricing unit the balances are denominated in. Null when n
|
|
52
|
+
#
|
|
53
|
+
# @param next_expiry_balance [Float, nil] The balance that expires on `next_expiry_date`. Null if `next_expiry_date` is nu
|
|
54
|
+
#
|
|
55
|
+
# @param next_expiry_date [Time, nil] The earliest `expiry_date` among active credit blocks. Null if none of them expi
|
|
56
|
+
#
|
|
57
|
+
# @param pending_payment_balance [Float] The total balance of credit blocks in `pending_payment` status. Not included in
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
end
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
module Customers
|
|
6
|
+
# @see Orb::Resources::Customers::Credits#fetch_balance
|
|
7
|
+
class CreditFetchBalanceParams < Orb::Internal::Type::BaseModel
|
|
8
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Orb::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute customer_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :customer_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute currency
|
|
17
|
+
# The ledger currency or custom pricing unit to use.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :currency, String, nil?: true
|
|
21
|
+
|
|
22
|
+
# @!method initialize(customer_id:, currency: nil, request_options: {})
|
|
23
|
+
# @param customer_id [String]
|
|
24
|
+
#
|
|
25
|
+
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
|
26
|
+
#
|
|
27
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
module Customers
|
|
6
|
+
# @see Orb::Resources::Customers::Credits#fetch_balance
|
|
7
|
+
class CreditFetchBalanceResponse < Orb::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute balance
|
|
9
|
+
# The customer's available credit balance: the sum of `balance` across their
|
|
10
|
+
# `active` credit blocks.
|
|
11
|
+
#
|
|
12
|
+
# @return [Float]
|
|
13
|
+
required :balance, Float
|
|
14
|
+
|
|
15
|
+
# @!attribute currency
|
|
16
|
+
# The currency or custom pricing unit the balances are denominated in. Null when
|
|
17
|
+
# no `currency` is passed and the customer has no credit ledger, in which case
|
|
18
|
+
# every balance is `0`.
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
required :currency, String, nil?: true
|
|
22
|
+
|
|
23
|
+
# @!attribute next_expiry_balance
|
|
24
|
+
# The balance that expires on `next_expiry_date`. Null if `next_expiry_date` is
|
|
25
|
+
# null.
|
|
26
|
+
#
|
|
27
|
+
# @return [Float, nil]
|
|
28
|
+
required :next_expiry_balance, Float, nil?: true
|
|
29
|
+
|
|
30
|
+
# @!attribute next_expiry_date
|
|
31
|
+
# The earliest `expiry_date` among active credit blocks. Null if none of them
|
|
32
|
+
# expire.
|
|
33
|
+
#
|
|
34
|
+
# @return [Time, nil]
|
|
35
|
+
required :next_expiry_date, Time, nil?: true
|
|
36
|
+
|
|
37
|
+
# @!attribute pending_payment_balance
|
|
38
|
+
# The total balance of credit blocks in `pending_payment` status. Not included in
|
|
39
|
+
# `balance` until the invoice that funds them is paid.
|
|
40
|
+
#
|
|
41
|
+
# @return [Float]
|
|
42
|
+
required :pending_payment_balance, Float
|
|
43
|
+
|
|
44
|
+
# @!method initialize(balance:, currency:, next_expiry_balance:, next_expiry_date:, pending_payment_balance:)
|
|
45
|
+
# Some parameter documentations has been truncated, see
|
|
46
|
+
# {Orb::Models::Customers::CreditFetchBalanceResponse} for more details.
|
|
47
|
+
#
|
|
48
|
+
# @param balance [Float] The customer's available credit balance: the sum of `balance` across their `acti
|
|
49
|
+
#
|
|
50
|
+
# @param currency [String, nil] The currency or custom pricing unit the balances are denominated in. Null when n
|
|
51
|
+
#
|
|
52
|
+
# @param next_expiry_balance [Float, nil] The balance that expires on `next_expiry_date`. Null if `next_expiry_date` is nu
|
|
53
|
+
#
|
|
54
|
+
# @param next_expiry_date [Time, nil] The earliest `expiry_date` among active credit blocks. Null if none of them expi
|
|
55
|
+
#
|
|
56
|
+
# @param pending_payment_balance [Float] The total balance of credit blocks in `pending_payment` status. Not included in
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
data/lib/orb/models/invoice.rb
CHANGED
|
@@ -381,6 +381,22 @@ module Orb
|
|
|
381
381
|
# @return [Time, nil]
|
|
382
382
|
required :scheduled_issue_at, Time, nil?: true
|
|
383
383
|
|
|
384
|
+
# @!attribute service_period_end
|
|
385
|
+
# The latest `end_date` of the invoice's line items, including any line items
|
|
386
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
387
|
+
# line items.
|
|
388
|
+
#
|
|
389
|
+
# @return [Time, nil]
|
|
390
|
+
required :service_period_end, Time, nil?: true
|
|
391
|
+
|
|
392
|
+
# @!attribute service_period_start
|
|
393
|
+
# The earliest `start_date` of the invoice's line items, including any line items
|
|
394
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
395
|
+
# line items.
|
|
396
|
+
#
|
|
397
|
+
# @return [Time, nil]
|
|
398
|
+
required :service_period_start, Time, nil?: true
|
|
399
|
+
|
|
384
400
|
# @!attribute shipping_address
|
|
385
401
|
#
|
|
386
402
|
# @return [Orb::Models::Address, nil]
|
|
@@ -430,7 +446,7 @@ module Orb
|
|
|
430
446
|
# @return [Boolean]
|
|
431
447
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
|
432
448
|
|
|
433
|
-
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
449
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
434
450
|
# Some parameter documentations has been truncated, see {Orb::Models::Invoice} for
|
|
435
451
|
# more details.
|
|
436
452
|
#
|
|
@@ -510,6 +526,10 @@ module Orb
|
|
|
510
526
|
#
|
|
511
527
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
|
512
528
|
#
|
|
529
|
+
# @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
|
|
530
|
+
#
|
|
531
|
+
# @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
|
|
532
|
+
#
|
|
513
533
|
# @param shipping_address [Orb::Models::Address, nil]
|
|
514
534
|
#
|
|
515
535
|
# @param status [Symbol, Orb::Models::Invoice::Status]
|
|
@@ -379,6 +379,22 @@ module Orb
|
|
|
379
379
|
# @return [Time, nil]
|
|
380
380
|
required :scheduled_issue_at, Time, nil?: true
|
|
381
381
|
|
|
382
|
+
# @!attribute service_period_end
|
|
383
|
+
# The latest `end_date` of the invoice's line items, including any line items
|
|
384
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
385
|
+
# line items.
|
|
386
|
+
#
|
|
387
|
+
# @return [Time, nil]
|
|
388
|
+
required :service_period_end, Time, nil?: true
|
|
389
|
+
|
|
390
|
+
# @!attribute service_period_start
|
|
391
|
+
# The earliest `start_date` of the invoice's line items, including any line items
|
|
392
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
393
|
+
# line items.
|
|
394
|
+
#
|
|
395
|
+
# @return [Time, nil]
|
|
396
|
+
required :service_period_start, Time, nil?: true
|
|
397
|
+
|
|
382
398
|
# @!attribute shipping_address
|
|
383
399
|
#
|
|
384
400
|
# @return [Orb::Models::Address, nil]
|
|
@@ -434,7 +450,7 @@ module Orb
|
|
|
434
450
|
# @return [Boolean]
|
|
435
451
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
|
436
452
|
|
|
437
|
-
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, target_date:, total:, voided_at:, will_auto_issue:)
|
|
453
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, target_date:, total:, voided_at:, will_auto_issue:)
|
|
438
454
|
# Some parameter documentations has been truncated, see
|
|
439
455
|
# {Orb::Models::InvoiceFetchUpcomingResponse} for more details.
|
|
440
456
|
#
|
|
@@ -506,6 +522,10 @@ module Orb
|
|
|
506
522
|
#
|
|
507
523
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
|
508
524
|
#
|
|
525
|
+
# @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
|
|
526
|
+
#
|
|
527
|
+
# @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
|
|
528
|
+
#
|
|
509
529
|
# @param shipping_address [Orb::Models::Address, nil]
|
|
510
530
|
#
|
|
511
531
|
# @param status [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status]
|
|
@@ -334,6 +334,22 @@ module Orb
|
|
|
334
334
|
# @return [Time, nil]
|
|
335
335
|
required :scheduled_issue_at, Time, nil?: true
|
|
336
336
|
|
|
337
|
+
# @!attribute service_period_end
|
|
338
|
+
# The latest `end_date` of the invoice's line items, including any line items
|
|
339
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
340
|
+
# line items.
|
|
341
|
+
#
|
|
342
|
+
# @return [Time, nil]
|
|
343
|
+
required :service_period_end, Time, nil?: true
|
|
344
|
+
|
|
345
|
+
# @!attribute service_period_start
|
|
346
|
+
# The earliest `start_date` of the invoice's line items, including any line items
|
|
347
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
348
|
+
# line items.
|
|
349
|
+
#
|
|
350
|
+
# @return [Time, nil]
|
|
351
|
+
required :service_period_start, Time, nil?: true
|
|
352
|
+
|
|
337
353
|
# @!attribute shipping_address
|
|
338
354
|
#
|
|
339
355
|
# @return [Orb::Models::Address, nil]
|
|
@@ -377,7 +393,7 @@ module Orb
|
|
|
377
393
|
# @return [Boolean]
|
|
378
394
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
|
379
395
|
|
|
380
|
-
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
396
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
381
397
|
# Some parameter documentations has been truncated, see
|
|
382
398
|
# {Orb::Models::InvoiceIssueSummaryResponse} for more details.
|
|
383
399
|
#
|
|
@@ -438,6 +454,10 @@ module Orb
|
|
|
438
454
|
#
|
|
439
455
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
|
440
456
|
#
|
|
457
|
+
# @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
|
|
458
|
+
#
|
|
459
|
+
# @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
|
|
460
|
+
#
|
|
441
461
|
# @param shipping_address [Orb::Models::Address, nil]
|
|
442
462
|
#
|
|
443
463
|
# @param status [Symbol, Orb::Models::InvoiceIssueSummaryResponse::Status]
|
|
@@ -391,6 +391,22 @@ module Orb
|
|
|
391
391
|
# @return [Time, nil]
|
|
392
392
|
required :scheduled_issue_at, Time, nil?: true
|
|
393
393
|
|
|
394
|
+
# @!attribute service_period_end
|
|
395
|
+
# The latest `end_date` of the invoice's line items, including any line items
|
|
396
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
397
|
+
# line items.
|
|
398
|
+
#
|
|
399
|
+
# @return [Time, nil]
|
|
400
|
+
required :service_period_end, Time, nil?: true
|
|
401
|
+
|
|
402
|
+
# @!attribute service_period_start
|
|
403
|
+
# The earliest `start_date` of the invoice's line items, including any line items
|
|
404
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
405
|
+
# line items.
|
|
406
|
+
#
|
|
407
|
+
# @return [Time, nil]
|
|
408
|
+
required :service_period_start, Time, nil?: true
|
|
409
|
+
|
|
394
410
|
# @!attribute shipping_address
|
|
395
411
|
#
|
|
396
412
|
# @return [Orb::Models::Address, nil]
|
|
@@ -434,7 +450,7 @@ module Orb
|
|
|
434
450
|
# @return [Boolean]
|
|
435
451
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
|
436
452
|
|
|
437
|
-
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
453
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
438
454
|
# Some parameter documentations has been truncated, see
|
|
439
455
|
# {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice} for more details.
|
|
440
456
|
#
|
|
@@ -495,6 +511,10 @@ module Orb
|
|
|
495
511
|
#
|
|
496
512
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
|
497
513
|
#
|
|
514
|
+
# @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
|
|
515
|
+
#
|
|
516
|
+
# @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
|
|
517
|
+
#
|
|
498
518
|
# @param shipping_address [Orb::Models::Address, nil]
|
|
499
519
|
#
|
|
500
520
|
# @param status [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::Status]
|
|
@@ -334,6 +334,22 @@ module Orb
|
|
|
334
334
|
# @return [Time, nil]
|
|
335
335
|
required :scheduled_issue_at, Time, nil?: true
|
|
336
336
|
|
|
337
|
+
# @!attribute service_period_end
|
|
338
|
+
# The latest `end_date` of the invoice's line items, including any line items
|
|
339
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
340
|
+
# line items.
|
|
341
|
+
#
|
|
342
|
+
# @return [Time, nil]
|
|
343
|
+
required :service_period_end, Time, nil?: true
|
|
344
|
+
|
|
345
|
+
# @!attribute service_period_start
|
|
346
|
+
# The earliest `start_date` of the invoice's line items, including any line items
|
|
347
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
348
|
+
# line items.
|
|
349
|
+
#
|
|
350
|
+
# @return [Time, nil]
|
|
351
|
+
required :service_period_start, Time, nil?: true
|
|
352
|
+
|
|
337
353
|
# @!attribute shipping_address
|
|
338
354
|
#
|
|
339
355
|
# @return [Orb::Models::Address, nil]
|
|
@@ -377,7 +393,7 @@ module Orb
|
|
|
377
393
|
# @return [Boolean]
|
|
378
394
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
|
379
395
|
|
|
380
|
-
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
396
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
381
397
|
# Some parameter documentations has been truncated, see
|
|
382
398
|
# {Orb::Models::InvoiceListSummaryResponse} for more details.
|
|
383
399
|
#
|
|
@@ -438,6 +454,10 @@ module Orb
|
|
|
438
454
|
#
|
|
439
455
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
|
440
456
|
#
|
|
457
|
+
# @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
|
|
458
|
+
#
|
|
459
|
+
# @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
|
|
460
|
+
#
|
|
441
461
|
# @param shipping_address [Orb::Models::Address, nil]
|
|
442
462
|
#
|
|
443
463
|
# @param status [Symbol, Orb::Models::InvoiceListSummaryResponse::Status]
|
|
@@ -474,6 +474,22 @@ module Orb
|
|
|
474
474
|
# @return [Time, nil]
|
|
475
475
|
required :scheduled_issue_at, Time, nil?: true
|
|
476
476
|
|
|
477
|
+
# @!attribute service_period_end
|
|
478
|
+
# The latest `end_date` of the invoice's line items, including any line items
|
|
479
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
480
|
+
# line items.
|
|
481
|
+
#
|
|
482
|
+
# @return [Time, nil]
|
|
483
|
+
required :service_period_end, Time, nil?: true
|
|
484
|
+
|
|
485
|
+
# @!attribute service_period_start
|
|
486
|
+
# The earliest `start_date` of the invoice's line items, including any line items
|
|
487
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
488
|
+
# line items.
|
|
489
|
+
#
|
|
490
|
+
# @return [Time, nil]
|
|
491
|
+
required :service_period_start, Time, nil?: true
|
|
492
|
+
|
|
477
493
|
# @!attribute shipping_address
|
|
478
494
|
#
|
|
479
495
|
# @return [Orb::Models::Address, nil]
|
|
@@ -518,7 +534,7 @@ module Orb
|
|
|
518
534
|
# @return [Boolean]
|
|
519
535
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
|
520
536
|
|
|
521
|
-
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
537
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
522
538
|
# Some parameter documentations has been truncated, see
|
|
523
539
|
# {Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice}
|
|
524
540
|
# for more details.
|
|
@@ -580,6 +596,10 @@ module Orb
|
|
|
580
596
|
#
|
|
581
597
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
|
582
598
|
#
|
|
599
|
+
# @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
|
|
600
|
+
#
|
|
601
|
+
# @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
|
|
602
|
+
#
|
|
583
603
|
# @param shipping_address [Orb::Models::Address, nil]
|
|
584
604
|
#
|
|
585
605
|
# @param status [Symbol, Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice::Status]
|
|
@@ -474,6 +474,22 @@ module Orb
|
|
|
474
474
|
# @return [Time, nil]
|
|
475
475
|
required :scheduled_issue_at, Time, nil?: true
|
|
476
476
|
|
|
477
|
+
# @!attribute service_period_end
|
|
478
|
+
# The latest `end_date` of the invoice's line items, including any line items
|
|
479
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
480
|
+
# line items.
|
|
481
|
+
#
|
|
482
|
+
# @return [Time, nil]
|
|
483
|
+
required :service_period_end, Time, nil?: true
|
|
484
|
+
|
|
485
|
+
# @!attribute service_period_start
|
|
486
|
+
# The earliest `start_date` of the invoice's line items, including any line items
|
|
487
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
488
|
+
# line items.
|
|
489
|
+
#
|
|
490
|
+
# @return [Time, nil]
|
|
491
|
+
required :service_period_start, Time, nil?: true
|
|
492
|
+
|
|
477
493
|
# @!attribute shipping_address
|
|
478
494
|
#
|
|
479
495
|
# @return [Orb::Models::Address, nil]
|
|
@@ -518,7 +534,7 @@ module Orb
|
|
|
518
534
|
# @return [Boolean]
|
|
519
535
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
|
520
536
|
|
|
521
|
-
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
537
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
522
538
|
# Some parameter documentations has been truncated, see
|
|
523
539
|
# {Orb::Models::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice}
|
|
524
540
|
# for more details.
|
|
@@ -580,6 +596,10 @@ module Orb
|
|
|
580
596
|
#
|
|
581
597
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
|
582
598
|
#
|
|
599
|
+
# @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
|
|
600
|
+
#
|
|
601
|
+
# @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
|
|
602
|
+
#
|
|
583
603
|
# @param shipping_address [Orb::Models::Address, nil]
|
|
584
604
|
#
|
|
585
605
|
# @param status [Symbol, Orb::Models::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status]
|
|
@@ -395,6 +395,22 @@ module Orb
|
|
|
395
395
|
# @return [Time, nil]
|
|
396
396
|
required :scheduled_issue_at, Time, nil?: true
|
|
397
397
|
|
|
398
|
+
# @!attribute service_period_end
|
|
399
|
+
# The latest `end_date` of the invoice's line items, including any line items
|
|
400
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
401
|
+
# line items.
|
|
402
|
+
#
|
|
403
|
+
# @return [Time, nil]
|
|
404
|
+
required :service_period_end, Time, nil?: true
|
|
405
|
+
|
|
406
|
+
# @!attribute service_period_start
|
|
407
|
+
# The earliest `start_date` of the invoice's line items, including any line items
|
|
408
|
+
# hidden because they have zero quantity. This is `null` when the invoice has no
|
|
409
|
+
# line items.
|
|
410
|
+
#
|
|
411
|
+
# @return [Time, nil]
|
|
412
|
+
required :service_period_start, Time, nil?: true
|
|
413
|
+
|
|
398
414
|
# @!attribute shipping_address
|
|
399
415
|
#
|
|
400
416
|
# @return [Orb::Models::Address, nil]
|
|
@@ -439,7 +455,7 @@ module Orb
|
|
|
439
455
|
# @return [Boolean]
|
|
440
456
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
|
441
457
|
|
|
442
|
-
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
458
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
|
443
459
|
# Some parameter documentations has been truncated, see
|
|
444
460
|
# {Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice}
|
|
445
461
|
# for more details.
|
|
@@ -501,6 +517,10 @@ module Orb
|
|
|
501
517
|
#
|
|
502
518
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
|
503
519
|
#
|
|
520
|
+
# @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
|
|
521
|
+
#
|
|
522
|
+
# @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
|
|
523
|
+
#
|
|
504
524
|
# @param shipping_address [Orb::Models::Address, nil]
|
|
505
525
|
#
|
|
506
526
|
# @param status [Symbol, Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::Status]
|