lago_ruby 0.46.0.pre.beta

data/docs/CreditNoteAppliedTaxObject.md

@@ -0,0 +1,38 @@
+# LagoAPI::CreditNoteAppliedTaxObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_credit_note_id** | **String** | Unique identifier of the credit note, created by Lago. | [optional] |
+| **base_amount_cents** | **Integer** |  | [optional] |
+| **lago_id** | **String** | Unique identifier of the applied tax, created by Lago. | [optional] |
+| **lago_tax_id** | **String** | Unique identifier of the tax, created by Lago. | [optional] |
+| **tax_name** | **String** | Name of the tax. | [optional] |
+| **tax_code** | **String** | Unique code used to identify the tax associated with the API request. | [optional] |
+| **tax_rate** | **Float** | The percentage rate of the tax | [optional] |
+| **tax_description** | **String** | Internal description of the taxe | [optional] |
+| **amount_cents** | **Integer** | Amount of the tax | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **created_at** | **Time** | The date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteAppliedTaxObject.new(
+  lago_credit_note_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  base_amount_cents: 100,
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_tax_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  tax_name: TVA,
+  tax_code: french_standard_vat,
+  tax_rate: 20,
+  tax_description: French standard VAT,
+  amount_cents: 2000,
+  amount_currency: null,
+  created_at: 2022-09-14T16:35:31Z
+)
+```
+

data/docs/CreditNoteCreateInput.md

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

data/docs/CreditNoteCreateInputCreditNote.md

@@ -0,0 +1,28 @@
+# LagoAPI::CreditNoteCreateInputCreditNote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** | The invoice unique identifier, created by Lago. |  |
+| **reason** | **String** | The reason of the credit note creation. Possible values are `duplicated_charge`, `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge` or `other`. | [optional] |
+| **description** | **String** | The description of the credit note. | [optional] |
+| **credit_amount_cents** | **Integer** | The total amount to be credited on the customer balance. | [optional] |
+| **refund_amount_cents** | **Integer** | The total amount to be refunded to the customer. | [optional] |
+| **items** | [**Array<CreditNoteCreateInputCreditNoteItemsInner>**](CreditNoteCreateInputCreditNoteItemsInner.md) | The list of credit note’s items. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteCreateInputCreditNote.new(
+  invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  reason: duplicated_charge,
+  description: description,
+  credit_amount_cents: 10,
+  refund_amount_cents: 5,
+  items: [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":10},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":5}]
+)
+```
+

data/docs/CreditNoteCreateInputCreditNoteItemsInner.md

@@ -0,0 +1,20 @@
+# LagoAPI::CreditNoteCreateInputCreditNoteItemsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fee_id** | **String** | The fee unique identifier, created by Lago. |  |
+| **amount_cents** | **Integer** | The amount of the credit note item, expressed in cents. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteCreateInputCreditNoteItemsInner.new(
+  fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  amount_cents: 10
+)
+```
+

data/docs/CreditNoteItemObject.md

@@ -0,0 +1,24 @@
+# LagoAPI::CreditNoteItemObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | The credit note’s item unique identifier, created by Lago. |  |
+| **amount_cents** | **Integer** | The credit note’s item amount, expressed in cents. |  |
+| **amount_currency** | [**Currency**](Currency.md) |  |  |
+| **fee** | [**CreditNoteItemObjectFee**](CreditNoteItemObjectFee.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteItemObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  amount_cents: 100,
+  amount_currency: null,
+  fee: null
+)
+```
+

data/docs/CreditNoteItemObjectFee.md

@@ -0,0 +1,74 @@
+# LagoAPI::CreditNoteItemObjectFee
+
+## 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. | [optional] |
+| **lago_group_id** | **String** | Unique identifier assigned to the group that the fee belongs to | [optional] |
+| **lago_invoice_id** | **String** | Unique identifier assigned to the invoice that the fee belongs to | [optional] |
+| **lago_true_up_fee_id** | **String** | Unique identifier assigned to the true-up fee when a minimum has been set to the charge. This identifier helps to distinguish and manage the true-up fee associated with the charge, which may be applicable when a minimum threshold or limit is set for the charge amount. | [optional] |
+| **lago_true_up_parent_fee_id** | **String** | Unique identifier assigned to the parent fee on which the true-up fee is assigned. This identifier establishes the relationship between the parent fee and the associated true-up fee. | [optional] |
+| **lago_subscription_id** | **String** | Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
+| **lago_customer_id** | **String** | Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
+| **external_customer_id** | **String** | Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
+| **external_subscription_id** | **String** | Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
+| **amount_cents** | **Integer** | The cost of this specific fee, excluding any applicable taxes. |  |
+| **amount_currency** | [**Currency**](Currency.md) |  |  |
+| **taxes_amount_cents** | **Integer** | The cost of the tax associated with this specific fee. |  |
+| **taxes_rate** | **Float** | The tax rate associated with this specific fee. |  |
+| **units** | **String** | The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer. |  |
+| **total_amount_cents** | **Integer** | The cost of this specific fee, including any applicable taxes. |  |
+| **total_amount_currency** | [**Currency**](Currency.md) |  |  |
+| **events_count** | **Integer** | The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process. | [optional] |
+| **pay_in_advance** | **Boolean** | Flag that indicates whether the fee was paid in advance. It serves as a boolean value, where `true` represents that the fee was paid in advance (straightaway), and `false` indicates that the fee was not paid in arrears (at the end of the period). |  |
+| **invoiceable** | **Boolean** | Flag that indicates whether the fee was included on the invoice. It serves as a boolean value, where `true` represents that the fee was included on the invoice, and `false` indicates that the fee was not included on the invoice. |  |
+| **from_date** | **Time** | The beginning date of the period that the fee covers. It is applicable only to `subscription` and `charge` fees. This field indicates the start date of the billing period or subscription period associated with the fee. | [optional] |
+| **to_date** | **Time** | The ending date of the period that the fee covers. It is applicable only to `subscription` and `charge` fees. This field indicates the end date of the billing period or subscription period associated with the fee. | [optional] |
+| **payment_status** | **String** | Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are `pending`, `succeeded`, `failed` and `refunded`. |  |
+| **created_at** | **Time** | The date and time when the fee was created. It is provided in Coordinated Universal Time (UTC) format. | [optional] |
+| **succeeded_at** | **Time** | The date and time when the payment for the fee was successfully processed. It is provided in Coordinated Universal Time (UTC) format. | [optional] |
+| **failed_at** | **Time** | The date and time when the payment for the fee failed to process. It is provided in Coordinated Universal Time (UTC) format. | [optional] |
+| **refunded_at** | **Time** | The date and time when the payment for the fee was refunded. It is provided in Coordinated Universal Time (UTC) format | [optional] |
+| **event_transaction_id** | **String** | Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is `charge` and the payment for the fee is made in advance (`pay_in_advance` is set to `true`). | [optional] |
+| **item** | [**FeeObjectItem**](FeeObjectItem.md) |  |  |
+| **applied_taxes** | [**Array<FeeAppliedTaxObject>**](FeeAppliedTaxObject.md) | List of fee applied taxes | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteItemObjectFee.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_group_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_true_up_fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_true_up_parent_fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_subscription_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_customer_id: external_id,
+  external_subscription_id: external_id,
+  amount_cents: 100,
+  amount_currency: null,
+  taxes_amount_cents: 20,
+  taxes_rate: 20,
+  units: 0.32,
+  total_amount_cents: 120,
+  total_amount_currency: null,
+  events_count: 23,
+  pay_in_advance: true,
+  invoiceable: true,
+  from_date: 2022-04-29T08:59:51Z,
+  to_date: 2022-05-29T08:59:51Z,
+  payment_status: pending,
+  created_at: 2022-08-24T14:58:59Z,
+  succeeded_at: 2022-08-24T14:58:59Z,
+  failed_at: 2022-08-24T14:58:59Z,
+  refunded_at: 2022-08-24T14:58:59Z,
+  event_transaction_id: transaction_1234567890,
+  item: null,
+  applied_taxes: null
+)
+```
+

data/docs/CreditNoteObject.md

@@ -0,0 +1,64 @@
+# LagoAPI::CreditNoteObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | The credit note unique identifier, created by Lago. |  |
+| **sequential_id** | **Integer** | The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice. |  |
+| **number** | **String** | The credit note unique number. |  |
+| **lago_invoice_id** | **String** | Unique identifier assigned to the invoice that the credit note belongs to |  |
+| **invoice_number** | **String** | The invoice unique number, related to the credit note. |  |
+| **issuing_date** | **Date** | The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created. |  |
+| **credit_status** | **String** | The status of the credit portion of the credit note. It indicates the current state or condition of the credit amount associated with the credit note. The possible values for this field are:  - `available`: this status indicates that an amount remains available for future usage. The credit can be applied towards future transactions or invoices. - `consumed`: this status indicates that the credit amount has been fully consumed. The remaining amount is 0, indicating that the credit has been utilized in its entirety. - `voided`: this status indicates that the remaining amount of the credit cannot be used any further. The credit has been voided and is no longer available for application or redemption. | [optional] |
+| **refund_status** | **String** | The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:  - `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet. - `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient. - `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned. | [optional] |
+| **reason** | **String** | The reason of the credit note creation. Possible values are `duplicated_charge`, `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge` or `other`. |  |
+| **description** | **String** | The description of the credit note. | [optional] |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **total_amount_cents** | **Integer** | The total amount of the credit note, expressed in cents. |  |
+| **taxes_amount_cents** | **Integer** | The tax amount of the credit note, expressed in cents. |  |
+| **taxes_rate** | **Float** | The tax rate associated with this specific credit note. |  |
+| **sub_total_excluding_taxes_amount_cents** | **Integer** | The subtotal of the credit note excluding any applicable taxes, expressed in cents. |  |
+| **balance_amount_cents** | **Integer** | The remaining credit note amount, expressed in cents. |  |
+| **credit_amount_cents** | **Integer** | The credited amount of the credit note, expressed in cents. |  |
+| **refund_amount_cents** | **Integer** | The refunded amount of the credit note, expressed in cents. |  |
+| **coupons_adjustement_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. |  |
+| **created_at** | **Time** | The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC). |  |
+| **updated_at** | **Time** | The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC). |  |
+| **file_url** | **String** | The PDF file of the credit note. | [optional] |
+| **items** | [**Array<CreditNoteItemObject>**](CreditNoteItemObject.md) | Array of credit note’s items. | [optional] |
+| **applied_taxes** | [**Array<CreditNoteAppliedTaxObject>**](CreditNoteAppliedTaxObject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  sequential_id: 2,
+  number: LAG-1234-CN2,
+  lago_invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  invoice_number: LAG-1234,
+  issuing_date: Tue Dec 06 00:00:00 UTC 2022,
+  credit_status: available,
+  refund_status: pending,
+  reason: other,
+  description: Free text,
+  currency: null,
+  total_amount_cents: 120,
+  taxes_amount_cents: 20,
+  taxes_rate: 20,
+  sub_total_excluding_taxes_amount_cents: 100,
+  balance_amount_cents: 100,
+  credit_amount_cents: 100,
+  refund_amount_cents: 0,
+  coupons_adjustement_amount_cents: 20,
+  created_at: 2022-09-14T16:35:31Z,
+  updated_at: 2022-09-14T16:35:31Z,
+  file_url: https://getlago.com/credit_note/file,
+  items: null,
+  applied_taxes: null
+)
+```
+

data/docs/CreditNoteUpdateInput.md

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

data/docs/CreditNoteUpdateInputCreditNote.md

@@ -0,0 +1,18 @@
+# LagoAPI::CreditNoteUpdateInputCreditNote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **refund_status** | **String** | The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:  - `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet. - `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient. - `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteUpdateInputCreditNote.new(
+  refund_status: succeeded
+)
+```
+

data/docs/CreditNotes.md

@@ -0,0 +1,18 @@
+# LagoAPI::CreditNotes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_notes** | [**Array<CreditNoteObject>**](CreditNoteObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNotes.new(
+  credit_notes: null
+)
+```
+