lago_ruby 0.46.0.pre.beta

data/docs/InvoiceObjectExtended.md

@@ -0,0 +1,68 @@
+# LagoAPI::InvoiceObjectExtended
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system. |  |
+| **sequential_id** | **Integer** | This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context. |  |
+| **number** | **String** | The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system. |  |
+| **issuing_date** | **Date** | The date when the invoice was issued. It is provided in the ISO 8601 date format. |  |
+| **payment_due_date** | **Date** | The payment due date for the invoice, specified in the ISO 8601 date format. | [optional] |
+| **net_payment_term** | **Integer** | The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized. | [optional] |
+| **invoice_type** | **String** | The type of invoice issued. Possible values are `subscription`, `one-off` or `credit`. |  |
+| **status** | **String** | The status of the invoice. It indicates the current state of the invoice and can have two possible values: - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice. - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore. |  |
+| **payment_status** | **String** | The status of the payment associated with the invoice. It can have one of the following values: - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint. - `succeeded`: the payment of the invoice has been successfully processed. - `failed`: the payment of the invoice has failed or encountered an error during processing. |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **fees_amount_cents** | **Integer** | The total sum of fees amount in cents. It calculates the cumulative amount of all the fees associated with the invoice, providing a consolidated value. |  |
+| **coupons_amount_cents** | **Integer** | The total sum of all coupons discounted on the invoice. It calculates the cumulative discount amount applied by coupons, expressed in cents. |  |
+| **credit_notes_amount_cents** | **Integer** | The total sum of all credit notes discounted on the invoice. It calculates the cumulative discount amount applied by credit notes, expressed in cents. |  |
+| **sub_total_excluding_taxes_amount_cents** | **Integer** | Subtotal amount, excluding taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version: - Version 1: is equal to the sum of `fees_amount_cents`, minus `coupons_amount_cents`, and minus `prepaid_credit_amount_cents`. - Version 2: is equal to the `fees_amount_cents`. - Version 3: is equal to the `fees_amount_cents`, minus `coupons_amount_cents` |  |
+| **taxes_amount_cents** | **Integer** | The sum of tax amount associated with the invoice, expressed in cents. |  |
+| **sub_total_including_taxes_amount_cents** | **Integer** | Subtotal amount, including taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version: - Version 1: is equal to the `total_amount_cents`. - Version 2: is equal to the sum of `fees_amount_cents` and `taxes_amount_cents`. - Version 3: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents` |  |
+| **prepaid_credit_amount_cents** | **Integer** | The total sum of all prepaid credits discounted on the invoice. It calculates the cumulative discount amount applied by prepaid credits, expressed in cents. |  |
+| **total_amount_cents** | **Integer** | The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes. |  |
+| **version_number** | **Integer** |  |  |
+| **file_url** | **String** | Contains the URL that provides direct access to the invoice PDF file. You can use this URL to download or view the PDF document of the invoice | [optional] |
+| **customer** | [**InvoiceObjectCustomer**](InvoiceObjectCustomer.md) |  | [optional] |
+| **metadata** | [**Array<InvoiceMetadataObject>**](InvoiceMetadataObject.md) |  | [optional] |
+| **applied_taxes** | [**Array<InvoiceAppliedTaxObject>**](InvoiceAppliedTaxObject.md) |  | [optional] |
+| **credits** | [**Array<CreditObject>**](CreditObject.md) |  | [optional] |
+| **fees** | [**Array<FeeObject>**](FeeObject.md) |  | [optional] |
+| **subscriptions** | [**Array<SubscriptionObject>**](SubscriptionObject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceObjectExtended.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  sequential_id: 2,
+  number: LAG-1234-001-002,
+  issuing_date: Sat Apr 30 00:00:00 UTC 2022,
+  payment_due_date: Sat Apr 30 00:00:00 UTC 2022,
+  net_payment_term: 30,
+  invoice_type: subscription,
+  status: finalized,
+  payment_status: succeeded,
+  currency: null,
+  fees_amount_cents: 100,
+  coupons_amount_cents: 10,
+  credit_notes_amount_cents: 10,
+  sub_total_excluding_taxes_amount_cents: 100,
+  taxes_amount_cents: 20,
+  sub_total_including_taxes_amount_cents: 120,
+  prepaid_credit_amount_cents: 0,
+  total_amount_cents: 100,
+  version_number: 3,
+  file_url: https://getlago.com/invoice/file,
+  customer: null,
+  metadata: null,
+  applied_taxes: null,
+  credits: null,
+  fees: null,
+  subscriptions: null
+)
+```
+

data/docs/InvoiceOneOffCreateInput.md

@@ -0,0 +1,18 @@
+# LagoAPI::InvoiceOneOffCreateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice** | [**InvoiceOneOffCreateInputInvoice**](InvoiceOneOffCreateInputInvoice.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceOneOffCreateInput.new(
+  invoice: null
+)
+```
+

data/docs/InvoiceOneOffCreateInputInvoice.md

@@ -0,0 +1,22 @@
+# LagoAPI::InvoiceOneOffCreateInputInvoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_customer_id** | **String** | Unique identifier assigned to the customer in your application. |  |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **fees** | [**Array<InvoiceOneOffCreateInputInvoiceFeesInner>**](InvoiceOneOffCreateInputInvoiceFeesInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceOneOffCreateInputInvoice.new(
+  external_customer_id: hooli_1234,
+  currency: null,
+  fees: null
+)
+```
+

data/docs/InvoiceOneOffCreateInputInvoiceFeesInner.md

@@ -0,0 +1,26 @@
+# LagoAPI::InvoiceOneOffCreateInputInvoiceFeesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **add_on_code** | **String** | The code of the add-on used as invoice item. |  |
+| **unit_amount_cents** | **Integer** | The amount of the fee per unit, expressed in cents. By default, the amount of the add-on is used. | [optional] |
+| **units** | **String** | The quantity of units associated with the fee. By default, only 1 unit is added to the invoice. | [optional] |
+| **description** | **String** | This is a description | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceOneOffCreateInputInvoiceFeesInner.new(
+  add_on_code: setup_fee,
+  unit_amount_cents: 12000,
+  units: 2.5,
+  description: The description of the fee line item in the invoice. By default, the description of the add-on is used.,
+  tax_codes: ["french_standard_vat"]
+)
+```
+

data/docs/InvoiceUpdateInput.md

@@ -0,0 +1,18 @@
+# LagoAPI::InvoiceUpdateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice** | [**InvoiceUpdateInputInvoice**](InvoiceUpdateInputInvoice.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceUpdateInput.new(
+  invoice: null
+)
+```
+

data/docs/InvoiceUpdateInputInvoice.md

@@ -0,0 +1,20 @@
+# LagoAPI::InvoiceUpdateInputInvoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_status** | **String** | The payment status of the invoice. Possible values are `pending`, `failed` or `succeeded`. | [optional] |
+| **metadata** | [**Array<InvoiceUpdateInputInvoiceMetadataInner>**](InvoiceUpdateInputInvoiceMetadataInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceUpdateInputInvoice.new(
+  payment_status: succeeded,
+  metadata: null
+)
+```
+

data/docs/InvoiceUpdateInputInvoiceMetadataInner.md

@@ -0,0 +1,22 @@
+# LagoAPI::InvoiceUpdateInputInvoiceMetadataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The metadata object identifier. Only required when updating existing metadata. | [optional] |
+| **key** | **String** | The key in the key-value pair of the metadata. | [optional] |
+| **value** | **String** | The value in the key-value pair of the metadata. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceUpdateInputInvoiceMetadataInner.new(
+  id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  key: digital_ref_id,
+  value: INV-0123456-98765
+)
+```
+