This repository has been archived by the owner on Dec 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a779b1e
commit a602b76
Showing
229 changed files
with
4,496 additions
and
427 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # LagoAPI::CreditNoteEstimateInput | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **credit_note** | [**CreditNoteEstimateInputCreditNote**](CreditNoteEstimateInputCreditNote.md) | | | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'lago_ruby' | ||
|
|
||
| instance = LagoAPI::CreditNoteEstimateInput.new( | ||
| credit_note: null | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # LagoAPI::CreditNoteEstimateInputCreditNote | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **invoice_id** | **String** | The invoice unique identifier, created by Lago. | | | ||
| | **items** | [**Array<CreditNoteEstimateInputCreditNoteItemsInner>**](CreditNoteEstimateInputCreditNoteItemsInner.md) | The list of credit note’s items. | | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'lago_ruby' | ||
|
|
||
| instance = LagoAPI::CreditNoteEstimateInputCreditNote.new( | ||
| invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90, | ||
| items: [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":10},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":5}] | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # LagoAPI::CreditNoteEstimateInputCreditNoteItemsInner | ||
|
|
||
| ## 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::CreditNoteEstimateInputCreditNoteItemsInner.new( | ||
| fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90, | ||
| amount_cents: 10 | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # LagoAPI::CreditNoteEstimated | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **estimated_credit_note** | [**CreditNoteEstimatedEstimatedCreditNote**](CreditNoteEstimatedEstimatedCreditNote.md) | | | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'lago_ruby' | ||
|
|
||
| instance = LagoAPI::CreditNoteEstimated.new( | ||
| estimated_credit_note: null | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # LagoAPI::CreditNoteEstimatedEstimatedCreditNote | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **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. | | | ||
| | **currency** | [**Currency**](Currency.md) | | | | ||
| | **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. | | | ||
| | **max_creditable_amount_cents** | **Integer** | The credited amount of the credit note, expressed in cents. | | | ||
| | **max_refundable_amount_cents** | **Integer** | The refunded amount of the credit note, expressed in cents. | | | ||
| | **coupons_adjustment_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. | | | ||
| | **items** | [**Array<CreditNoteEstimatedEstimatedCreditNoteItemsInner>**](CreditNoteEstimatedEstimatedCreditNoteItemsInner.md) | Array of credit note’s items. | | | ||
| | **applied_taxes** | [**Array<CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner>**](CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.md) | | [optional] | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'lago_ruby' | ||
|
|
||
| instance = LagoAPI::CreditNoteEstimatedEstimatedCreditNote.new( | ||
| lago_invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90, | ||
| invoice_number: LAG-1234, | ||
| currency: null, | ||
| taxes_amount_cents: 20, | ||
| taxes_rate: 20, | ||
| sub_total_excluding_taxes_amount_cents: 100, | ||
| max_creditable_amount_cents: 100, | ||
| max_refundable_amount_cents: 0, | ||
| coupons_adjustment_amount_cents: 20, | ||
| items: null, | ||
| applied_taxes: null | ||
| ) | ||
| ``` | ||
|
|
32 changes: 32 additions & 0 deletions
32
docs/CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # LagoAPI::CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **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] | | ||
| | **base_amount_cents** | **Integer** | | [optional] | | ||
| | **amount_cents** | **Integer** | Amount of the tax | [optional] | | ||
| | **amount_currency** | [**Currency**](Currency.md) | | [optional] | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'lago_ruby' | ||
|
|
||
| instance = LagoAPI::CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.new( | ||
| lago_tax_id: 1a901a90-1a90-1a90-1a90-1a901a901a90, | ||
| tax_name: TVA, | ||
| tax_code: french_standard_vat, | ||
| tax_rate: 20, | ||
| tax_description: French standard VAT, | ||
| base_amount_cents: 100, | ||
| amount_cents: 2000, | ||
| amount_currency: null | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # LagoAPI::CreditNoteEstimatedEstimatedCreditNoteItemsInner | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Type | Description | Notes | | ||
| | ---- | ---- | ----------- | ----- | | ||
| | **amount_cents** | **Integer** | The credit note’s item amount, expressed in cents. | | | ||
| | **lago_fee_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. | | | ||
|
|
||
| ## Example | ||
|
|
||
| ```ruby | ||
| require 'lago_ruby' | ||
|
|
||
| instance = LagoAPI::CreditNoteEstimatedEstimatedCreditNoteItemsInner.new( | ||
| amount_cents: 100, | ||
| lago_fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90 | ||
| ) | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.