nordlet 0.5.6 → 0.5.7
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/lib/nordlet/account/client.rb +2 -1
- data/lib/nordlet/account/types/companies_create_account_request.rb +16 -0
- data/lib/nordlet/account/types/companies_create_account_request_country_code.rb +222 -3
- data/lib/nordlet/account/types/companies_create_account_request_default_invoice_locale.rb +44 -0
- data/lib/nordlet/account/types/companies_create_account_response.rb +2 -0
- data/lib/nordlet/account/types/companies_profile_account_response.rb +18 -0
- data/lib/nordlet/account/types/companies_update_account_request.rb +14 -0
- data/lib/nordlet/account/types/companies_update_account_request_default_invoice_locale.rb +44 -0
- data/lib/nordlet/account/types/companies_update_account_response.rb +18 -0
- data/lib/nordlet/account/types/me_account_response_companies_item.rb +2 -0
- data/lib/nordlet/billing/client.rb +40 -3
- data/lib/nordlet/billing/types/account_get_billing_response.rb +2 -0
- data/lib/nordlet/billing/types/account_get_billing_response_plan.rb +1 -0
- data/lib/nordlet/billing/types/account_set_account_type_billing_response.rb +2 -0
- data/lib/nordlet/billing/types/account_set_account_type_billing_response_plan.rb +1 -0
- data/lib/nordlet/billing/types/account_set_auto_top_up_billing_response.rb +2 -0
- data/lib/nordlet/billing/types/account_set_auto_top_up_billing_response_plan.rb +1 -0
- data/lib/nordlet/billing/types/account_set_overdraft_cap_billing_response.rb +2 -0
- data/lib/nordlet/billing/types/account_set_overdraft_cap_billing_response_plan.rb +1 -0
- data/lib/nordlet/billing/types/account_set_plan_billing_request_plan.rb +1 -0
- data/lib/nordlet/billing/types/account_set_plan_billing_response.rb +2 -0
- data/lib/nordlet/billing/types/account_set_plan_billing_response_plan.rb +1 -0
- data/lib/nordlet/billing/types/flat_rate_confirm_billing_response.rb +2 -0
- data/lib/nordlet/billing/types/flat_rate_confirm_billing_response_plan.rb +1 -0
- data/lib/nordlet/billing/types/flat_rate_create_billing_request_plan.rb +1 -0
- data/lib/nordlet/billing/types/subscription_cancel_billing_request.rb +9 -0
- data/lib/nordlet/billing/types/subscription_cancel_billing_response.rb +51 -0
- data/lib/nordlet/billing/types/subscription_cancel_billing_response_account_type.rb +14 -0
- data/lib/nordlet/billing/types/subscription_cancel_billing_response_auto_top_up.rb +15 -0
- data/lib/nordlet/billing/types/subscription_cancel_billing_response_month_to_date.rb +27 -0
- data/lib/nordlet/billing/types/subscription_cancel_billing_response_plan.rb +16 -0
- data/lib/nordlet/billing/types/subscription_cancel_billing_response_plans_value.rb +19 -0
- data/lib/nordlet/billing/types/subscription_cancel_billing_response_status.rb +15 -0
- data/lib/nordlet/billing/types/subscription_cancel_billing_response_top_up.rb +13 -0
- data/lib/nordlet/billing/types/topup_confirm_billing_response.rb +2 -0
- data/lib/nordlet/billing/types/topup_confirm_billing_response_plan.rb +1 -0
- data/lib/nordlet/declarations/client.rb +45 -4
- data/lib/nordlet/declarations/types/de_euer_get_declarations_request.rb +11 -0
- data/lib/nordlet/declarations/types/de_euer_get_declarations_response.rb +17 -0
- data/lib/nordlet/declarations/types/de_euer_get_declarations_response_rows_item.rb +19 -0
- data/lib/nordlet/declarations/types/de_euer_get_declarations_response_rows_item_anlage.rb +14 -0
- data/lib/nordlet/declarations/types/de_return_facts_get_declarations_response_facts.rb +6 -0
- data/lib/nordlet/declarations/types/de_return_facts_get_declarations_response_facts_euer_einkunftsart.rb +15 -0
- data/lib/nordlet/declarations/types/de_return_facts_set_declarations_request_facts.rb +6 -0
- data/lib/nordlet/declarations/types/de_return_facts_set_declarations_request_facts_euer_einkunftsart.rb +15 -0
- data/lib/nordlet/declarations/types/de_return_facts_set_declarations_response_facts.rb +6 -0
- data/lib/nordlet/declarations/types/de_return_facts_set_declarations_response_facts_euer_einkunftsart.rb +15 -0
- data/lib/nordlet/declarations/types/de_returns_generate_declarations_request_rule_key.rb +1 -0
- data/lib/nordlet/partners/client.rb +11 -10
- data/lib/nordlet/partners/types/create_partners_request.rb +4 -0
- data/lib/nordlet/partners/types/create_partners_request_invoice_currency.rb +97 -0
- data/lib/nordlet/partners/types/create_partners_request_invoice_locale.rb +44 -0
- data/lib/nordlet/partners/types/create_partners_response.rb +4 -0
- data/lib/nordlet/partners/types/find_or_create_partners_request.rb +4 -0
- data/lib/nordlet/partners/types/find_or_create_partners_request_invoice_currency.rb +97 -0
- data/lib/nordlet/partners/types/find_or_create_partners_request_invoice_locale.rb +44 -0
- data/lib/nordlet/partners/types/find_or_create_partners_response_partner.rb +4 -0
- data/lib/nordlet/partners/types/get_partners_response.rb +4 -0
- data/lib/nordlet/partners/types/list_partners_response_rows_item.rb +4 -0
- data/lib/nordlet/partners/types/update_partners_request.rb +4 -0
- data/lib/nordlet/partners/types/update_partners_request_invoice_currency.rb +97 -0
- data/lib/nordlet/partners/types/update_partners_request_invoice_locale.rb +44 -0
- data/lib/nordlet/partners/types/update_partners_response.rb +4 -0
- data/lib/nordlet/public/client.rb +111 -2
- data/lib/nordlet/public/types/invoices_checkout_public_request.rb +11 -0
- data/lib/nordlet/public/types/invoices_checkout_public_response.rb +11 -0
- data/lib/nordlet/public/types/invoices_get_public_request.rb +11 -0
- data/lib/nordlet/public/types/invoices_get_public_response.rb +47 -0
- data/lib/nordlet/public/types/invoices_get_public_response_buyer.rb +17 -0
- data/lib/nordlet/public/types/invoices_get_public_response_buyer_address.rb +17 -0
- data/lib/nordlet/public/types/invoices_get_public_response_lines_item.rb +21 -0
- data/lib/nordlet/public/types/invoices_get_public_response_payment_status.rb +15 -0
- data/lib/nordlet/public/types/invoices_get_public_response_seller.rb +31 -0
- data/lib/nordlet/public/types/invoices_get_public_response_seller_address.rb +17 -0
- data/lib/nordlet/public/types/invoices_get_public_response_status.rb +14 -0
- data/lib/nordlet/public/types/invoices_get_public_response_type.rb +16 -0
- data/lib/nordlet/public/types/invoices_pdf_public_request.rb +11 -0
- data/lib/nordlet/public/types/invoices_pdf_public_response.rb +15 -0
- data/lib/nordlet/sales/client.rb +237 -9
- data/lib/nordlet/sales/types/exports_month_sales_request.rb +13 -0
- data/lib/nordlet/sales/types/exports_month_sales_request_format.rb +15 -0
- data/lib/nordlet/sales/types/exports_month_sales_response.rb +15 -0
- data/lib/nordlet/sales/types/invoices_apply_advance_sales_response.rb +8 -0
- data/lib/nordlet/sales/types/invoices_card_payments_connect_sales_request.rb +13 -0
- data/lib/nordlet/sales/types/invoices_card_payments_connect_sales_response.rb +11 -0
- data/lib/nordlet/sales/types/invoices_card_payments_disconnect_sales_request.rb +9 -0
- data/lib/nordlet/sales/types/invoices_card_payments_disconnect_sales_response.rb +15 -0
- data/lib/nordlet/sales/types/invoices_card_payments_get_sales_request.rb +9 -0
- data/lib/nordlet/sales/types/invoices_card_payments_get_sales_response.rb +15 -0
- data/lib/nordlet/sales/types/invoices_create_sales_request.rb +6 -0
- data/lib/nordlet/sales/types/invoices_create_sales_request_locale.rb +29 -0
- data/lib/nordlet/sales/types/invoices_create_sales_response.rb +8 -0
- data/lib/nordlet/sales/types/invoices_get_sales_response.rb +8 -0
- data/lib/nordlet/sales/types/invoices_issue_sales_response.rb +8 -0
- data/lib/nordlet/sales/types/invoices_list_sales_response_rows_item.rb +8 -0
- data/lib/nordlet/sales/types/invoices_lock_sales_response.rb +8 -0
- data/lib/nordlet/sales/types/invoices_payment_link_sales_response_source.rb +1 -0
- data/lib/nordlet/sales/types/invoices_pdf_sales_request_locale.rb +29 -0
- data/lib/nordlet/sales/types/invoices_send_sales_request.rb +2 -0
- data/lib/nordlet/sales/types/invoices_send_sales_request_locale.rb +29 -0
- data/lib/nordlet/sales/types/invoices_unlock_sales_response.rb +8 -0
- data/lib/nordlet/sales/types/invoices_update_sales_request.rb +6 -0
- data/lib/nordlet/sales/types/invoices_update_sales_request_locale.rb +29 -0
- data/lib/nordlet/sales/types/invoices_update_sales_response.rb +8 -0
- data/lib/nordlet/sales/types/invoices_view_sales_request.rb +11 -0
- data/lib/nordlet/sales/types/invoices_view_sales_response.rb +49 -0
- data/lib/nordlet/sales/types/invoices_view_sales_response_buyer.rb +17 -0
- data/lib/nordlet/sales/types/invoices_view_sales_response_buyer_address.rb +17 -0
- data/lib/nordlet/sales/types/invoices_view_sales_response_lines_item.rb +21 -0
- data/lib/nordlet/sales/types/invoices_view_sales_response_payment_status.rb +15 -0
- data/lib/nordlet/sales/types/invoices_view_sales_response_seller.rb +31 -0
- data/lib/nordlet/sales/types/invoices_view_sales_response_seller_address.rb +17 -0
- data/lib/nordlet/sales/types/invoices_view_sales_response_status.rb +14 -0
- data/lib/nordlet/sales/types/invoices_view_sales_response_type.rb +16 -0
- data/lib/nordlet/sales/types/payments_list_sales_request.rb +17 -0
- data/lib/nordlet/sales/types/payments_list_sales_response.rb +19 -0
- data/lib/nordlet/sales/types/payments_list_sales_response_rows_item.rb +27 -0
- data/lib/nordlet/sales/types/payments_list_sales_response_rows_item_method.rb +15 -0
- data/lib/nordlet/sales/types/recurring_invoices_create_sales_request_locale.rb +29 -0
- data/lib/nordlet/sales/types/recurring_invoices_update_sales_request_locale.rb +29 -0
- data/lib/nordlet/version.rb +1 -1
- data/lib/nordlet/webhooks/types/subscriptions_create_webhooks_request_events_item.rb +1 -0
- data/lib/nordlet/webhooks/types/subscriptions_update_webhooks_request_events_item.rb +1 -0
- data/lib/nordlet.rb +61 -0
- data/reference.md +1296 -365
- metadata +63 -2
data/reference.md
CHANGED
|
@@ -3201,7 +3201,7 @@ client.partners.files_list(partner_id: "partnerId")
|
|
|
3201
3201
|
<dl>
|
|
3202
3202
|
<dd>
|
|
3203
3203
|
|
|
3204
|
-
Runs the overdue selection of the daily debt-reminder job for this company as of the company's current date and returns the overdue reminders it would send, without sending or recording anything. A partner is included when it has `autoDebtReminder`, is active, has an e-mail address, got no overdue reminder in the last `repeatDays` days (`partners/debt-reminders/settings/get`) and has issued invoices or advance invoices past their due date with an unpaid remainder; the interest per invoice is the remainder times the partner's `lateInterestPercent` times the days late over 365, and the totals are per currency. Sent reminders are listed by `partners/debt-reminders/list`.
|
|
3204
|
+
Runs the overdue selection of the daily debt-reminder job for this company as of the company's current date and returns the overdue reminders it would send, without sending or recording anything. A partner is included when it has `autoDebtReminder`, is active, has an e-mail address, got no overdue reminder in the last `repeatDays` days (`partners/debt-reminders/settings/get`) and has issued invoices or advance invoices with `debtRemindersEnabled` past their due date with an unpaid remainder; the interest per invoice is the remainder times the partner's `lateInterestPercent` times the days late over 365, and the totals are per currency. Sent reminders are listed by `partners/debt-reminders/list`.
|
|
3205
3205
|
</dd>
|
|
3206
3206
|
</dl>
|
|
3207
3207
|
</dd>
|
|
@@ -3403,7 +3403,7 @@ client.partners.debt_reminders_settings_get
|
|
|
3403
3403
|
<dl>
|
|
3404
3404
|
<dd>
|
|
3405
3405
|
|
|
3406
|
-
Changes the given fields of the company's debt-reminder schedule. `daysBefore` (1 to 90, or null to send nothing before the due date) makes the daily job send one "payment due soon" reminder per invoice that many days before its due date; `repeatDays` (1 to 90) is the number of days between overdue reminders to a partner. Only partners with `autoDebtReminder` get reminders
|
|
3406
|
+
Changes the given fields of the company's debt-reminder schedule. `daysBefore` (1 to 90, or null to send nothing before the due date) makes the daily job send one "payment due soon" reminder per invoice that many days before its due date; `repeatDays` (1 to 90) is the number of days between overdue reminders to a partner. Only partners with `autoDebtReminder` get reminders, and only for invoices with `debtRemindersEnabled`. A body without fields is refused with 400.
|
|
3407
3407
|
</dd>
|
|
3408
3408
|
</dl>
|
|
3409
3409
|
</dd>
|
|
@@ -3473,7 +3473,7 @@ client.partners.debt_reminders_settings_update
|
|
|
3473
3473
|
<dl>
|
|
3474
3474
|
<dd>
|
|
3475
3475
|
|
|
3476
|
-
Returns the next reminder the daily debt-reminder job would send for each unpaid issued invoice or advance invoice of the partners that get reminders (`autoDebtReminder`, active, with an e-mail address), as of the company's current date and sorted by `date`. A `before_due` reminder is sent once per invoice, `daysBefore` days before its due date or on the first daily run after that while the due date is still ahead; `overdue` reminders start the day after the due date and repeat every `repeatDays` days per partner, counting only overdue reminders. Nothing is sent or recorded.
|
|
3476
|
+
Returns the next reminder the daily debt-reminder job would send for each unpaid issued invoice or advance invoice with `debtRemindersEnabled` of the partners that get reminders (`autoDebtReminder`, active, with an e-mail address), as of the company's current date and sorted by `date`. A `before_due` reminder is sent once per invoice, `daysBefore` days before its due date or on the first daily run after that while the due date is still ahead; `overdue` reminders start the day after the due date and repeat every `repeatDays` days per partner, counting only overdue reminders. Nothing is sent or recorded.
|
|
3477
3477
|
</dd>
|
|
3478
3478
|
</dl>
|
|
3479
3479
|
</dd>
|
|
@@ -3898,6 +3898,22 @@ client.partners.create(name: "name")
|
|
|
3898
3898
|
<dl>
|
|
3899
3899
|
<dd>
|
|
3900
3900
|
|
|
3901
|
+
**invoice_currency:** `Nordlet::Partners::Types::CreatePartnersRequestInvoiceCurrency` — Currency a new invoice for this partner starts with when the invoice names none
|
|
3902
|
+
|
|
3903
|
+
</dd>
|
|
3904
|
+
</dl>
|
|
3905
|
+
|
|
3906
|
+
<dl>
|
|
3907
|
+
<dd>
|
|
3908
|
+
|
|
3909
|
+
**invoice_locale:** `Nordlet::Partners::Types::CreatePartnersRequestInvoiceLocale` — Language a new invoice for this partner starts with when the invoice names none
|
|
3910
|
+
|
|
3911
|
+
</dd>
|
|
3912
|
+
</dl>
|
|
3913
|
+
|
|
3914
|
+
<dl>
|
|
3915
|
+
<dd>
|
|
3916
|
+
|
|
3901
3917
|
**credit_limit:** `String`
|
|
3902
3918
|
|
|
3903
3919
|
</dd>
|
|
@@ -4224,6 +4240,22 @@ client.partners.find_or_create(name: "name")
|
|
|
4224
4240
|
<dl>
|
|
4225
4241
|
<dd>
|
|
4226
4242
|
|
|
4243
|
+
**invoice_currency:** `Nordlet::Partners::Types::FindOrCreatePartnersRequestInvoiceCurrency` — Currency a new invoice for this partner starts with when the invoice names none
|
|
4244
|
+
|
|
4245
|
+
</dd>
|
|
4246
|
+
</dl>
|
|
4247
|
+
|
|
4248
|
+
<dl>
|
|
4249
|
+
<dd>
|
|
4250
|
+
|
|
4251
|
+
**invoice_locale:** `Nordlet::Partners::Types::FindOrCreatePartnersRequestInvoiceLocale` — Language a new invoice for this partner starts with when the invoice names none
|
|
4252
|
+
|
|
4253
|
+
</dd>
|
|
4254
|
+
</dl>
|
|
4255
|
+
|
|
4256
|
+
<dl>
|
|
4257
|
+
<dd>
|
|
4258
|
+
|
|
4227
4259
|
**credit_limit:** `String`
|
|
4228
4260
|
|
|
4229
4261
|
</dd>
|
|
@@ -4620,6 +4652,22 @@ client.partners.update(id: "id")
|
|
|
4620
4652
|
<dl>
|
|
4621
4653
|
<dd>
|
|
4622
4654
|
|
|
4655
|
+
**invoice_currency:** `Nordlet::Partners::Types::UpdatePartnersRequestInvoiceCurrency` — Currency a new invoice for this partner starts with when the invoice names none
|
|
4656
|
+
|
|
4657
|
+
</dd>
|
|
4658
|
+
</dl>
|
|
4659
|
+
|
|
4660
|
+
<dl>
|
|
4661
|
+
<dd>
|
|
4662
|
+
|
|
4663
|
+
**invoice_locale:** `Nordlet::Partners::Types::UpdatePartnersRequestInvoiceLocale` — Language a new invoice for this partner starts with when the invoice names none
|
|
4664
|
+
|
|
4665
|
+
</dd>
|
|
4666
|
+
</dl>
|
|
4667
|
+
|
|
4668
|
+
<dl>
|
|
4669
|
+
<dd>
|
|
4670
|
+
|
|
4623
4671
|
**credit_limit:** `String`
|
|
4624
4672
|
|
|
4625
4673
|
</dd>
|
|
@@ -10658,7 +10706,7 @@ client.sales.invoices_create(
|
|
|
10658
10706
|
<dl>
|
|
10659
10707
|
<dd>
|
|
10660
10708
|
|
|
10661
|
-
**
|
|
10709
|
+
**pay_link_enabled:** `Internal::Types::Boolean` — Whether the PDF and the e-mail carry the payment link of the company payment link template
|
|
10662
10710
|
|
|
10663
10711
|
</dd>
|
|
10664
10712
|
</dl>
|
|
@@ -10666,7 +10714,7 @@ client.sales.invoices_create(
|
|
|
10666
10714
|
<dl>
|
|
10667
10715
|
<dd>
|
|
10668
10716
|
|
|
10669
|
-
**
|
|
10717
|
+
**debt_reminders_enabled:** `Internal::Types::Boolean` — Whether automatic debt reminders include this invoice when its partner has them turned on
|
|
10670
10718
|
|
|
10671
10719
|
</dd>
|
|
10672
10720
|
</dl>
|
|
@@ -10674,7 +10722,7 @@ client.sales.invoices_create(
|
|
|
10674
10722
|
<dl>
|
|
10675
10723
|
<dd>
|
|
10676
10724
|
|
|
10677
|
-
**
|
|
10725
|
+
**operation_type_id:** `String`
|
|
10678
10726
|
|
|
10679
10727
|
</dd>
|
|
10680
10728
|
</dl>
|
|
@@ -10682,7 +10730,7 @@ client.sales.invoices_create(
|
|
|
10682
10730
|
<dl>
|
|
10683
10731
|
<dd>
|
|
10684
10732
|
|
|
10685
|
-
**
|
|
10733
|
+
**document_series_id:** `String`
|
|
10686
10734
|
|
|
10687
10735
|
</dd>
|
|
10688
10736
|
</dl>
|
|
@@ -10690,7 +10738,7 @@ client.sales.invoices_create(
|
|
|
10690
10738
|
<dl>
|
|
10691
10739
|
<dd>
|
|
10692
10740
|
|
|
10693
|
-
**
|
|
10741
|
+
**series_label:** `String`
|
|
10694
10742
|
|
|
10695
10743
|
</dd>
|
|
10696
10744
|
</dl>
|
|
@@ -10698,7 +10746,7 @@ client.sales.invoices_create(
|
|
|
10698
10746
|
<dl>
|
|
10699
10747
|
<dd>
|
|
10700
10748
|
|
|
10701
|
-
**
|
|
10749
|
+
**order_number:** `String`
|
|
10702
10750
|
|
|
10703
10751
|
</dd>
|
|
10704
10752
|
</dl>
|
|
@@ -10706,7 +10754,7 @@ client.sales.invoices_create(
|
|
|
10706
10754
|
<dl>
|
|
10707
10755
|
<dd>
|
|
10708
10756
|
|
|
10709
|
-
**
|
|
10757
|
+
**issued_by_name:** `String`
|
|
10710
10758
|
|
|
10711
10759
|
</dd>
|
|
10712
10760
|
</dl>
|
|
@@ -10714,7 +10762,7 @@ client.sales.invoices_create(
|
|
|
10714
10762
|
<dl>
|
|
10715
10763
|
<dd>
|
|
10716
10764
|
|
|
10717
|
-
**
|
|
10765
|
+
**issued_by_title:** `String`
|
|
10718
10766
|
|
|
10719
10767
|
</dd>
|
|
10720
10768
|
</dl>
|
|
@@ -10722,7 +10770,7 @@ client.sales.invoices_create(
|
|
|
10722
10770
|
<dl>
|
|
10723
10771
|
<dd>
|
|
10724
10772
|
|
|
10725
|
-
**
|
|
10773
|
+
**received_by_name:** `String`
|
|
10726
10774
|
|
|
10727
10775
|
</dd>
|
|
10728
10776
|
</dl>
|
|
@@ -10730,7 +10778,7 @@ client.sales.invoices_create(
|
|
|
10730
10778
|
<dl>
|
|
10731
10779
|
<dd>
|
|
10732
10780
|
|
|
10733
|
-
**
|
|
10781
|
+
**received_by_title:** `String`
|
|
10734
10782
|
|
|
10735
10783
|
</dd>
|
|
10736
10784
|
</dl>
|
|
@@ -10738,61 +10786,23 @@ client.sales.invoices_create(
|
|
|
10738
10786
|
<dl>
|
|
10739
10787
|
<dd>
|
|
10740
10788
|
|
|
10741
|
-
**
|
|
10789
|
+
**discount_percent:** `String`
|
|
10742
10790
|
|
|
10743
10791
|
</dd>
|
|
10744
10792
|
</dl>
|
|
10745
|
-
</dd>
|
|
10746
|
-
</dl>
|
|
10747
|
-
|
|
10748
|
-
|
|
10749
|
-
</dd>
|
|
10750
|
-
</dl>
|
|
10751
|
-
</details>
|
|
10752
10793
|
|
|
10753
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_get</a>(request) -> Nordlet::Sales::Types::InvoicesGetSalesResponse</code></summary>
|
|
10754
10794
|
<dl>
|
|
10755
10795
|
<dd>
|
|
10756
10796
|
|
|
10757
|
-
|
|
10758
|
-
|
|
10759
|
-
<dl>
|
|
10760
|
-
<dd>
|
|
10761
|
-
|
|
10762
|
-
<dl>
|
|
10763
|
-
<dd>
|
|
10764
|
-
|
|
10765
|
-
Return one sale document with its lines, its VAT evidence and, on an advance invoice, the gross amount already applied to final invoices.
|
|
10766
|
-
</dd>
|
|
10767
|
-
</dl>
|
|
10797
|
+
**sales_tax_percent:** `String` — Sales tax as a percent of the net total, added to the invoice total. It is not posted to the ledger and is left out of VAT and national tax reports. Invoices only.
|
|
10798
|
+
|
|
10768
10799
|
</dd>
|
|
10769
10800
|
</dl>
|
|
10770
10801
|
|
|
10771
|
-
#### 🔌 Usage
|
|
10772
|
-
|
|
10773
|
-
<dl>
|
|
10774
|
-
<dd>
|
|
10775
|
-
|
|
10776
10802
|
<dl>
|
|
10777
10803
|
<dd>
|
|
10778
10804
|
|
|
10779
|
-
|
|
10780
|
-
client.sales.invoices_get(id: "id")
|
|
10781
|
-
```
|
|
10782
|
-
</dd>
|
|
10783
|
-
</dl>
|
|
10784
|
-
</dd>
|
|
10785
|
-
</dl>
|
|
10786
|
-
|
|
10787
|
-
#### ⚙️ Parameters
|
|
10788
|
-
|
|
10789
|
-
<dl>
|
|
10790
|
-
<dd>
|
|
10791
|
-
|
|
10792
|
-
<dl>
|
|
10793
|
-
<dd>
|
|
10794
|
-
|
|
10795
|
-
**id:** `String`
|
|
10805
|
+
**lines:** `Internal::Types::Array[Nordlet::Sales::Types::InvoicesCreateSalesRequestLinesItem]`
|
|
10796
10806
|
|
|
10797
10807
|
</dd>
|
|
10798
10808
|
</dl>
|
|
@@ -10812,7 +10822,7 @@ client.sales.invoices_get(id: "id")
|
|
|
10812
10822
|
</dl>
|
|
10813
10823
|
</details>
|
|
10814
10824
|
|
|
10815
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
10825
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_get</a>(request) -> Nordlet::Sales::Types::InvoicesGetSalesResponse</code></summary>
|
|
10816
10826
|
<dl>
|
|
10817
10827
|
<dd>
|
|
10818
10828
|
|
|
@@ -10824,7 +10834,7 @@ client.sales.invoices_get(id: "id")
|
|
|
10824
10834
|
<dl>
|
|
10825
10835
|
<dd>
|
|
10826
10836
|
|
|
10827
|
-
|
|
10837
|
+
Return one sale document with its lines, its VAT evidence and, on an advance invoice, the gross amount already applied to final invoices.
|
|
10828
10838
|
</dd>
|
|
10829
10839
|
</dl>
|
|
10830
10840
|
</dd>
|
|
@@ -10839,7 +10849,7 @@ Render a sale document, draft or issued, as a PDF returned base64-encoded. The d
|
|
|
10839
10849
|
<dd>
|
|
10840
10850
|
|
|
10841
10851
|
```ruby
|
|
10842
|
-
client.sales.
|
|
10852
|
+
client.sales.invoices_get(id: "id")
|
|
10843
10853
|
```
|
|
10844
10854
|
</dd>
|
|
10845
10855
|
</dl>
|
|
@@ -10862,14 +10872,6 @@ client.sales.invoices_pdf(id: "id")
|
|
|
10862
10872
|
<dl>
|
|
10863
10873
|
<dd>
|
|
10864
10874
|
|
|
10865
|
-
**locale:** `Nordlet::Sales::Types::InvoicesPdfSalesRequestLocale`
|
|
10866
|
-
|
|
10867
|
-
</dd>
|
|
10868
|
-
</dl>
|
|
10869
|
-
|
|
10870
|
-
<dl>
|
|
10871
|
-
<dd>
|
|
10872
|
-
|
|
10873
10875
|
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
10874
10876
|
|
|
10875
10877
|
</dd>
|
|
@@ -10882,7 +10884,7 @@ client.sales.invoices_pdf(id: "id")
|
|
|
10882
10884
|
</dl>
|
|
10883
10885
|
</details>
|
|
10884
10886
|
|
|
10885
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
10887
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_pdf</a>(request) -> Nordlet::Sales::Types::InvoicesPdfSalesResponse</code></summary>
|
|
10886
10888
|
<dl>
|
|
10887
10889
|
<dd>
|
|
10888
10890
|
|
|
@@ -10894,7 +10896,7 @@ client.sales.invoices_pdf(id: "id")
|
|
|
10894
10896
|
<dl>
|
|
10895
10897
|
<dd>
|
|
10896
10898
|
|
|
10897
|
-
|
|
10899
|
+
Render a sale document, draft or issued, as a PDF returned base64-encoded. The document's own `locale` wins over the requested one. When the company has a payment link template and the document is issued and not paid, the PDF carries the payment link.
|
|
10898
10900
|
</dd>
|
|
10899
10901
|
</dl>
|
|
10900
10902
|
</dd>
|
|
@@ -10909,7 +10911,7 @@ E-mail an issued sale document as a PDF attachment to `to`, else to the partner'
|
|
|
10909
10911
|
<dd>
|
|
10910
10912
|
|
|
10911
10913
|
```ruby
|
|
10912
|
-
client.sales.
|
|
10914
|
+
client.sales.invoices_pdf(id: "id")
|
|
10913
10915
|
```
|
|
10914
10916
|
</dd>
|
|
10915
10917
|
</dl>
|
|
@@ -10932,15 +10934,7 @@ client.sales.invoices_send(id: "id")
|
|
|
10932
10934
|
<dl>
|
|
10933
10935
|
<dd>
|
|
10934
10936
|
|
|
10935
|
-
**
|
|
10936
|
-
|
|
10937
|
-
</dd>
|
|
10938
|
-
</dl>
|
|
10939
|
-
|
|
10940
|
-
<dl>
|
|
10941
|
-
<dd>
|
|
10942
|
-
|
|
10943
|
-
**locale:** `Nordlet::Sales::Types::InvoicesSendSalesRequestLocale`
|
|
10937
|
+
**locale:** `Nordlet::Sales::Types::InvoicesPdfSalesRequestLocale`
|
|
10944
10938
|
|
|
10945
10939
|
</dd>
|
|
10946
10940
|
</dl>
|
|
@@ -10960,7 +10954,7 @@ client.sales.invoices_send(id: "id")
|
|
|
10960
10954
|
</dl>
|
|
10961
10955
|
</details>
|
|
10962
10956
|
|
|
10963
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
10957
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_view</a>(request) -> Nordlet::Sales::Types::InvoicesViewSalesResponse</code></summary>
|
|
10964
10958
|
<dl>
|
|
10965
10959
|
<dd>
|
|
10966
10960
|
|
|
@@ -10972,7 +10966,7 @@ client.sales.invoices_send(id: "id")
|
|
|
10972
10966
|
<dl>
|
|
10973
10967
|
<dd>
|
|
10974
10968
|
|
|
10975
|
-
|
|
10969
|
+
Return a sale document as its customer sees it: the seller as printed on it (the snapshot taken at issue, else the company), the buyer with address and e-mail, the lines, the totals, `paidOn` (the date of the latest payment once the document is paid), `payUrl` (as in `sales/invoices/payment-link`) and `token`, the document's customer token for `public/invoices/get` and `public/invoices/pdf`, created on first use; `token` is null on a draft.
|
|
10976
10970
|
</dd>
|
|
10977
10971
|
</dl>
|
|
10978
10972
|
</dd>
|
|
@@ -10987,7 +10981,7 @@ Render an issued invoice or credit note as a Peppol BIS Billing 3.0 UBL file, re
|
|
|
10987
10981
|
<dd>
|
|
10988
10982
|
|
|
10989
10983
|
```ruby
|
|
10990
|
-
client.sales.
|
|
10984
|
+
client.sales.invoices_view(id: "id")
|
|
10991
10985
|
```
|
|
10992
10986
|
</dd>
|
|
10993
10987
|
</dl>
|
|
@@ -11022,7 +11016,7 @@ client.sales.invoices_peppol_xml(id: "id")
|
|
|
11022
11016
|
</dl>
|
|
11023
11017
|
</details>
|
|
11024
11018
|
|
|
11025
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
11019
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_send</a>(request) -> Nordlet::Sales::Types::InvoicesSendSalesResponse</code></summary>
|
|
11026
11020
|
<dl>
|
|
11027
11021
|
<dd>
|
|
11028
11022
|
|
|
@@ -11034,7 +11028,7 @@ client.sales.invoices_peppol_xml(id: "id")
|
|
|
11034
11028
|
<dl>
|
|
11035
11029
|
<dd>
|
|
11036
11030
|
|
|
11037
|
-
|
|
11031
|
+
E-mail an issued sale document as a PDF attachment to `to`, else to the partner's e-mail address, and emit `sale_invoice.sent`. The PDF is the one of `sales/invoices/pdf`. With `quote: true` the document must be a draft: it is e-mailed as a quote (PDF titled quote, no payment link), stays a draft, and `sale_invoice.quote_sent` is emitted instead. Answers 422 when e-mail sending is not configured, when the document is not issued (or, with `quote`, not a draft), or when neither `to` nor the partner's e-mail is set.
|
|
11038
11032
|
</dd>
|
|
11039
11033
|
</dl>
|
|
11040
11034
|
</dd>
|
|
@@ -11049,7 +11043,7 @@ Send an issued invoice or credit note to the customer over Peppol through the co
|
|
|
11049
11043
|
<dd>
|
|
11050
11044
|
|
|
11051
11045
|
```ruby
|
|
11052
|
-
client.sales.
|
|
11046
|
+
client.sales.invoices_send(id: "id")
|
|
11053
11047
|
```
|
|
11054
11048
|
</dd>
|
|
11055
11049
|
</dl>
|
|
@@ -11072,61 +11066,7 @@ client.sales.invoices_peppol_send(id: "id")
|
|
|
11072
11066
|
<dl>
|
|
11073
11067
|
<dd>
|
|
11074
11068
|
|
|
11075
|
-
**
|
|
11076
|
-
|
|
11077
|
-
</dd>
|
|
11078
|
-
</dl>
|
|
11079
|
-
</dd>
|
|
11080
|
-
</dl>
|
|
11081
|
-
|
|
11082
|
-
|
|
11083
|
-
</dd>
|
|
11084
|
-
</dl>
|
|
11085
|
-
</details>
|
|
11086
|
-
|
|
11087
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_peppol_status</a>(request) -> Nordlet::Sales::Types::InvoicesPeppolStatusSalesResponse</code></summary>
|
|
11088
|
-
<dl>
|
|
11089
|
-
<dd>
|
|
11090
|
-
|
|
11091
|
-
#### 📝 Description
|
|
11092
|
-
|
|
11093
|
-
<dl>
|
|
11094
|
-
<dd>
|
|
11095
|
-
|
|
11096
|
-
<dl>
|
|
11097
|
-
<dd>
|
|
11098
|
-
|
|
11099
|
-
Ask the company's Peppol access point what happened to an invoice sent with `sales/invoices/peppol-send`, and store the answer: `pending`, `delivered` (the receiving access point confirmed it), `rejected` (the receiver refused it, see `detail`) or `failed` (it could not be delivered, see `detail`). The access point's webhook updates the same fields without this call. Storecove has no call for the status of a sent document, so for a Storecove access point this answers 422 and the status comes only from its webhook.
|
|
11100
|
-
</dd>
|
|
11101
|
-
</dl>
|
|
11102
|
-
</dd>
|
|
11103
|
-
</dl>
|
|
11104
|
-
|
|
11105
|
-
#### 🔌 Usage
|
|
11106
|
-
|
|
11107
|
-
<dl>
|
|
11108
|
-
<dd>
|
|
11109
|
-
|
|
11110
|
-
<dl>
|
|
11111
|
-
<dd>
|
|
11112
|
-
|
|
11113
|
-
```ruby
|
|
11114
|
-
client.sales.invoices_peppol_status(id: "id")
|
|
11115
|
-
```
|
|
11116
|
-
</dd>
|
|
11117
|
-
</dl>
|
|
11118
|
-
</dd>
|
|
11119
|
-
</dl>
|
|
11120
|
-
|
|
11121
|
-
#### ⚙️ Parameters
|
|
11122
|
-
|
|
11123
|
-
<dl>
|
|
11124
|
-
<dd>
|
|
11125
|
-
|
|
11126
|
-
<dl>
|
|
11127
|
-
<dd>
|
|
11128
|
-
|
|
11129
|
-
**id:** `String`
|
|
11069
|
+
**to:** `String`
|
|
11130
11070
|
|
|
11131
11071
|
</dd>
|
|
11132
11072
|
</dl>
|
|
@@ -11134,61 +11074,15 @@ client.sales.invoices_peppol_status(id: "id")
|
|
|
11134
11074
|
<dl>
|
|
11135
11075
|
<dd>
|
|
11136
11076
|
|
|
11137
|
-
**
|
|
11077
|
+
**locale:** `Nordlet::Sales::Types::InvoicesSendSalesRequestLocale`
|
|
11138
11078
|
|
|
11139
11079
|
</dd>
|
|
11140
11080
|
</dl>
|
|
11141
|
-
</dd>
|
|
11142
|
-
</dl>
|
|
11143
|
-
|
|
11144
|
-
|
|
11145
|
-
</dd>
|
|
11146
|
-
</dl>
|
|
11147
|
-
</details>
|
|
11148
|
-
|
|
11149
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_einvoice_xml</a>(request) -> Nordlet::Sales::Types::InvoicesEinvoiceXMLSalesResponse</code></summary>
|
|
11150
|
-
<dl>
|
|
11151
|
-
<dd>
|
|
11152
|
-
|
|
11153
|
-
#### 📝 Description
|
|
11154
|
-
|
|
11155
|
-
<dl>
|
|
11156
|
-
<dd>
|
|
11157
|
-
|
|
11158
|
-
<dl>
|
|
11159
|
-
<dd>
|
|
11160
|
-
|
|
11161
|
-
Render an issued invoice as the national e-invoicing payload for the company country: FatturaPA (IT), KSeF FA(3) (PL) or UBL CIUS-RO (RO). Review the warnings - data the invoice does not carry is flagged, never invented.
|
|
11162
|
-
</dd>
|
|
11163
|
-
</dl>
|
|
11164
|
-
</dd>
|
|
11165
|
-
</dl>
|
|
11166
|
-
|
|
11167
|
-
#### 🔌 Usage
|
|
11168
|
-
|
|
11169
|
-
<dl>
|
|
11170
|
-
<dd>
|
|
11171
|
-
|
|
11172
|
-
<dl>
|
|
11173
|
-
<dd>
|
|
11174
|
-
|
|
11175
|
-
```ruby
|
|
11176
|
-
client.sales.invoices_einvoice_xml(id: "id")
|
|
11177
|
-
```
|
|
11178
|
-
</dd>
|
|
11179
|
-
</dl>
|
|
11180
|
-
</dd>
|
|
11181
|
-
</dl>
|
|
11182
|
-
|
|
11183
|
-
#### ⚙️ Parameters
|
|
11184
11081
|
|
|
11185
11082
|
<dl>
|
|
11186
11083
|
<dd>
|
|
11187
11084
|
|
|
11188
|
-
|
|
11189
|
-
<dd>
|
|
11190
|
-
|
|
11191
|
-
**id:** `String`
|
|
11085
|
+
**quote:** `Internal::Types::Boolean`
|
|
11192
11086
|
|
|
11193
11087
|
</dd>
|
|
11194
11088
|
</dl>
|
|
@@ -11208,7 +11102,7 @@ client.sales.invoices_einvoice_xml(id: "id")
|
|
|
11208
11102
|
</dl>
|
|
11209
11103
|
</details>
|
|
11210
11104
|
|
|
11211
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
11105
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_peppol_xml</a>(request) -> Nordlet::Sales::Types::InvoicesPeppolXMLSalesResponse</code></summary>
|
|
11212
11106
|
<dl>
|
|
11213
11107
|
<dd>
|
|
11214
11108
|
|
|
@@ -11220,7 +11114,7 @@ client.sales.invoices_einvoice_xml(id: "id")
|
|
|
11220
11114
|
<dl>
|
|
11221
11115
|
<dd>
|
|
11222
11116
|
|
|
11223
|
-
|
|
11117
|
+
Render an issued invoice or credit note as a Peppol BIS Billing 3.0 UBL file, returned base64-encoded with the sender and receiver participant identifiers, without sending it; `sales/invoices/peppol-send` sends the same file. Answers 422 for a draft, a proforma or an advance invoice.
|
|
11224
11118
|
</dd>
|
|
11225
11119
|
</dl>
|
|
11226
11120
|
</dd>
|
|
@@ -11235,7 +11129,7 @@ Build the national e-invoicing payload and deliver it over the transport configu
|
|
|
11235
11129
|
<dd>
|
|
11236
11130
|
|
|
11237
11131
|
```ruby
|
|
11238
|
-
client.sales.
|
|
11132
|
+
client.sales.invoices_peppol_xml(id: "id")
|
|
11239
11133
|
```
|
|
11240
11134
|
</dd>
|
|
11241
11135
|
</dl>
|
|
@@ -11270,7 +11164,7 @@ client.sales.invoices_einvoice_send(id: "id")
|
|
|
11270
11164
|
</dl>
|
|
11271
11165
|
</details>
|
|
11272
11166
|
|
|
11273
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
11167
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_peppol_send</a>(request) -> Nordlet::Sales::Types::InvoicesPeppolSendSalesResponse</code></summary>
|
|
11274
11168
|
<dl>
|
|
11275
11169
|
<dd>
|
|
11276
11170
|
|
|
@@ -11282,7 +11176,7 @@ client.sales.invoices_einvoice_send(id: "id")
|
|
|
11282
11176
|
<dl>
|
|
11283
11177
|
<dd>
|
|
11284
11178
|
|
|
11285
|
-
|
|
11179
|
+
Send an issued invoice or credit note to the customer over Peppol through the company's own access point (Account → Compliance → EU; Nordlet supports Recommand, Storecove and e-invoice.be). Without one the call is refused with 422 and the document can only be downloaded with `sales/invoices/peppol-xml`. `status` is `pending` until the receiving access point confirms, then `delivered`; `failed` and `rejected` come with `detail`, and the invoice can then be sent again. Later changes arrive through the access point's webhook and are announced as `sale_invoice.peppol_delivered`, `sale_invoice.peppol_rejected` and `sale_invoice.peppol_failed`.
|
|
11286
11180
|
</dd>
|
|
11287
11181
|
</dl>
|
|
11288
11182
|
</dd>
|
|
@@ -11297,7 +11191,7 @@ Ask the national e-invoicing channel what happened to an invoice that was alread
|
|
|
11297
11191
|
<dd>
|
|
11298
11192
|
|
|
11299
11193
|
```ruby
|
|
11300
|
-
client.sales.
|
|
11194
|
+
client.sales.invoices_peppol_send(id: "id")
|
|
11301
11195
|
```
|
|
11302
11196
|
</dd>
|
|
11303
11197
|
</dl>
|
|
@@ -11332,7 +11226,7 @@ client.sales.invoices_einvoice_status(id: "id")
|
|
|
11332
11226
|
</dl>
|
|
11333
11227
|
</details>
|
|
11334
11228
|
|
|
11335
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
11229
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_peppol_status</a>(request) -> Nordlet::Sales::Types::InvoicesPeppolStatusSalesResponse</code></summary>
|
|
11336
11230
|
<dl>
|
|
11337
11231
|
<dd>
|
|
11338
11232
|
|
|
@@ -11344,7 +11238,7 @@ client.sales.invoices_einvoice_status(id: "id")
|
|
|
11344
11238
|
<dl>
|
|
11345
11239
|
<dd>
|
|
11346
11240
|
|
|
11347
|
-
|
|
11241
|
+
Ask the company's Peppol access point what happened to an invoice sent with `sales/invoices/peppol-send`, and store the answer: `pending`, `delivered` (the receiving access point confirmed it), `rejected` (the receiver refused it, see `detail`) or `failed` (it could not be delivered, see `detail`). The access point's webhook updates the same fields without this call. Storecove has no call for the status of a sent document, so for a Storecove access point this answers 422 and the status comes only from its webhook.
|
|
11348
11242
|
</dd>
|
|
11349
11243
|
</dl>
|
|
11350
11244
|
</dd>
|
|
@@ -11359,7 +11253,7 @@ Change a draft sale document. Fields left out keep their value, `lines` replaces
|
|
|
11359
11253
|
<dd>
|
|
11360
11254
|
|
|
11361
11255
|
```ruby
|
|
11362
|
-
client.sales.
|
|
11256
|
+
client.sales.invoices_peppol_status(id: "id")
|
|
11363
11257
|
```
|
|
11364
11258
|
</dd>
|
|
11365
11259
|
</dl>
|
|
@@ -11382,95 +11276,61 @@ client.sales.invoices_update(id: "id")
|
|
|
11382
11276
|
<dl>
|
|
11383
11277
|
<dd>
|
|
11384
11278
|
|
|
11385
|
-
**
|
|
11279
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
11386
11280
|
|
|
11387
11281
|
</dd>
|
|
11388
11282
|
</dl>
|
|
11389
|
-
|
|
11390
|
-
<dl>
|
|
11391
|
-
<dd>
|
|
11392
|
-
|
|
11393
|
-
**agreement_id:** `String`
|
|
11394
|
-
|
|
11395
11283
|
</dd>
|
|
11396
11284
|
</dl>
|
|
11397
11285
|
|
|
11398
|
-
<dl>
|
|
11399
|
-
<dd>
|
|
11400
11286
|
|
|
11401
|
-
**currency:** `String`
|
|
11402
|
-
|
|
11403
11287
|
</dd>
|
|
11404
11288
|
</dl>
|
|
11289
|
+
</details>
|
|
11405
11290
|
|
|
11291
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_einvoice_xml</a>(request) -> Nordlet::Sales::Types::InvoicesEinvoiceXMLSalesResponse</code></summary>
|
|
11406
11292
|
<dl>
|
|
11407
11293
|
<dd>
|
|
11408
11294
|
|
|
11409
|
-
|
|
11410
|
-
|
|
11411
|
-
</dd>
|
|
11412
|
-
</dl>
|
|
11295
|
+
#### 📝 Description
|
|
11413
11296
|
|
|
11414
11297
|
<dl>
|
|
11415
11298
|
<dd>
|
|
11416
11299
|
|
|
11417
|
-
**due_date:** `String`
|
|
11418
|
-
|
|
11419
|
-
</dd>
|
|
11420
|
-
</dl>
|
|
11421
|
-
|
|
11422
11300
|
<dl>
|
|
11423
11301
|
<dd>
|
|
11424
11302
|
|
|
11425
|
-
|
|
11426
|
-
|
|
11303
|
+
Render an issued invoice as the national e-invoicing payload for the company country: FatturaPA (IT), KSeF FA(3) (PL) or UBL CIUS-RO (RO). Review the warnings - data the invoice does not carry is flagged, never invented.
|
|
11427
11304
|
</dd>
|
|
11428
11305
|
</dl>
|
|
11429
|
-
|
|
11430
|
-
<dl>
|
|
11431
|
-
<dd>
|
|
11432
|
-
|
|
11433
|
-
**intrastat_transport_mode:** `String`
|
|
11434
|
-
|
|
11435
11306
|
</dd>
|
|
11436
11307
|
</dl>
|
|
11437
11308
|
|
|
11309
|
+
#### 🔌 Usage
|
|
11310
|
+
|
|
11438
11311
|
<dl>
|
|
11439
11312
|
<dd>
|
|
11440
11313
|
|
|
11441
|
-
**intrastat_delivery_terms:** `String`
|
|
11442
|
-
|
|
11443
|
-
</dd>
|
|
11444
|
-
</dl>
|
|
11445
|
-
|
|
11446
11314
|
<dl>
|
|
11447
11315
|
<dd>
|
|
11448
11316
|
|
|
11449
|
-
|
|
11450
|
-
|
|
11317
|
+
```ruby
|
|
11318
|
+
client.sales.invoices_einvoice_xml(id: "id")
|
|
11319
|
+
```
|
|
11451
11320
|
</dd>
|
|
11452
11321
|
</dl>
|
|
11453
|
-
|
|
11454
|
-
<dl>
|
|
11455
|
-
<dd>
|
|
11456
|
-
|
|
11457
|
-
**intrastat_nature_of_transaction:** `String`
|
|
11458
|
-
|
|
11459
11322
|
</dd>
|
|
11460
11323
|
</dl>
|
|
11461
11324
|
|
|
11325
|
+
#### ⚙️ Parameters
|
|
11326
|
+
|
|
11462
11327
|
<dl>
|
|
11463
11328
|
<dd>
|
|
11464
11329
|
|
|
11465
|
-
**vat_country_code:** `String`
|
|
11466
|
-
|
|
11467
|
-
</dd>
|
|
11468
|
-
</dl>
|
|
11469
|
-
|
|
11470
11330
|
<dl>
|
|
11471
11331
|
<dd>
|
|
11472
11332
|
|
|
11473
|
-
**
|
|
11333
|
+
**id:** `String`
|
|
11474
11334
|
|
|
11475
11335
|
</dd>
|
|
11476
11336
|
</dl>
|
|
@@ -11478,95 +11338,61 @@ client.sales.invoices_update(id: "id")
|
|
|
11478
11338
|
<dl>
|
|
11479
11339
|
<dd>
|
|
11480
11340
|
|
|
11481
|
-
**
|
|
11341
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
11482
11342
|
|
|
11483
11343
|
</dd>
|
|
11484
11344
|
</dl>
|
|
11485
|
-
|
|
11486
|
-
<dl>
|
|
11487
|
-
<dd>
|
|
11488
|
-
|
|
11489
|
-
**locale:** `Nordlet::Sales::Types::InvoicesUpdateSalesRequestLocale`
|
|
11490
|
-
|
|
11491
11345
|
</dd>
|
|
11492
11346
|
</dl>
|
|
11493
11347
|
|
|
11494
|
-
<dl>
|
|
11495
|
-
<dd>
|
|
11496
11348
|
|
|
11497
|
-
**operation_type_id:** `String`
|
|
11498
|
-
|
|
11499
11349
|
</dd>
|
|
11500
11350
|
</dl>
|
|
11351
|
+
</details>
|
|
11501
11352
|
|
|
11353
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_einvoice_send</a>(request) -> Nordlet::Sales::Types::InvoicesEinvoiceSendSalesResponse</code></summary>
|
|
11502
11354
|
<dl>
|
|
11503
11355
|
<dd>
|
|
11504
11356
|
|
|
11505
|
-
|
|
11506
|
-
|
|
11507
|
-
</dd>
|
|
11508
|
-
</dl>
|
|
11357
|
+
#### 📝 Description
|
|
11509
11358
|
|
|
11510
11359
|
<dl>
|
|
11511
11360
|
<dd>
|
|
11512
11361
|
|
|
11513
|
-
**series_label:** `String`
|
|
11514
|
-
|
|
11515
|
-
</dd>
|
|
11516
|
-
</dl>
|
|
11517
|
-
|
|
11518
11362
|
<dl>
|
|
11519
11363
|
<dd>
|
|
11520
11364
|
|
|
11521
|
-
|
|
11522
|
-
|
|
11365
|
+
Build the national e-invoicing payload and deliver it over the transport configured for the country gateway in compliance settings. With transport=direct the request talks to the tax authority itself - SdICoop over 2-way TLS for Italy, a KSeF session for Poland, ANAF SPV OAuth for Romania - and returns the national number as soon as the channel assigns one. With transport=bridge the payload goes to the configured bridge endpoint (an accredited intermediary or connector) instead.
|
|
11523
11366
|
</dd>
|
|
11524
11367
|
</dl>
|
|
11525
|
-
|
|
11526
|
-
<dl>
|
|
11527
|
-
<dd>
|
|
11528
|
-
|
|
11529
|
-
**order_number:** `String`
|
|
11530
|
-
|
|
11531
11368
|
</dd>
|
|
11532
11369
|
</dl>
|
|
11533
11370
|
|
|
11371
|
+
#### 🔌 Usage
|
|
11372
|
+
|
|
11534
11373
|
<dl>
|
|
11535
11374
|
<dd>
|
|
11536
11375
|
|
|
11537
|
-
**issued_by_name:** `String`
|
|
11538
|
-
|
|
11539
|
-
</dd>
|
|
11540
|
-
</dl>
|
|
11541
|
-
|
|
11542
11376
|
<dl>
|
|
11543
11377
|
<dd>
|
|
11544
11378
|
|
|
11545
|
-
|
|
11546
|
-
|
|
11379
|
+
```ruby
|
|
11380
|
+
client.sales.invoices_einvoice_send(id: "id")
|
|
11381
|
+
```
|
|
11547
11382
|
</dd>
|
|
11548
11383
|
</dl>
|
|
11549
|
-
|
|
11550
|
-
<dl>
|
|
11551
|
-
<dd>
|
|
11552
|
-
|
|
11553
|
-
**received_by_name:** `String`
|
|
11554
|
-
|
|
11555
11384
|
</dd>
|
|
11556
11385
|
</dl>
|
|
11557
11386
|
|
|
11387
|
+
#### ⚙️ Parameters
|
|
11388
|
+
|
|
11558
11389
|
<dl>
|
|
11559
11390
|
<dd>
|
|
11560
11391
|
|
|
11561
|
-
**received_by_title:** `String`
|
|
11562
|
-
|
|
11563
|
-
</dd>
|
|
11564
|
-
</dl>
|
|
11565
|
-
|
|
11566
11392
|
<dl>
|
|
11567
11393
|
<dd>
|
|
11568
11394
|
|
|
11569
|
-
**
|
|
11395
|
+
**id:** `String`
|
|
11570
11396
|
|
|
11571
11397
|
</dd>
|
|
11572
11398
|
</dl>
|
|
@@ -11586,7 +11412,7 @@ client.sales.invoices_update(id: "id")
|
|
|
11586
11412
|
</dl>
|
|
11587
11413
|
</details>
|
|
11588
11414
|
|
|
11589
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
11415
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_einvoice_status</a>(request) -> Nordlet::Sales::Types::InvoicesEinvoiceStatusSalesResponse</code></summary>
|
|
11590
11416
|
<dl>
|
|
11591
11417
|
<dd>
|
|
11592
11418
|
|
|
@@ -11598,7 +11424,7 @@ client.sales.invoices_update(id: "id")
|
|
|
11598
11424
|
<dl>
|
|
11599
11425
|
<dd>
|
|
11600
11426
|
|
|
11601
|
-
|
|
11427
|
+
Ask the national e-invoicing channel what happened to an invoice that was already sent, and store the answer. Italy, Poland and Romania return the outcome only on request - none of them calls back - so this is the way the national number and any rejection reason reach the invoice.
|
|
11602
11428
|
</dd>
|
|
11603
11429
|
</dl>
|
|
11604
11430
|
</dd>
|
|
@@ -11613,7 +11439,7 @@ Delete a draft sale document and release the time entries billed on it. Answers
|
|
|
11613
11439
|
<dd>
|
|
11614
11440
|
|
|
11615
11441
|
```ruby
|
|
11616
|
-
client.sales.
|
|
11442
|
+
client.sales.invoices_einvoice_status(id: "id")
|
|
11617
11443
|
```
|
|
11618
11444
|
</dd>
|
|
11619
11445
|
</dl>
|
|
@@ -11648,7 +11474,7 @@ client.sales.invoices_delete(id: "id")
|
|
|
11648
11474
|
</dl>
|
|
11649
11475
|
</details>
|
|
11650
11476
|
|
|
11651
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
11477
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_update</a>(request) -> Nordlet::Sales::Types::InvoicesUpdateSalesResponse</code></summary>
|
|
11652
11478
|
<dl>
|
|
11653
11479
|
<dd>
|
|
11654
11480
|
|
|
@@ -11660,7 +11486,7 @@ client.sales.invoices_delete(id: "id")
|
|
|
11660
11486
|
<dl>
|
|
11661
11487
|
<dd>
|
|
11662
11488
|
|
|
11663
|
-
|
|
11489
|
+
Change a draft sale document. Fields left out keep their value, `lines` replaces every line, a changed `discountPercent` recomputes the existing lines, and `salesTaxPercent` (invoices only, null removes it) recomputes the sales tax and the total. Answers 409 when the document is issued or locked, and 422 under the checks of `sales/invoices/create` (the credited document's partner and currency, the OSS and IOSS country, VAT on the lines, the operation type and document series).
|
|
11664
11490
|
</dd>
|
|
11665
11491
|
</dl>
|
|
11666
11492
|
</dd>
|
|
@@ -11675,7 +11501,7 @@ Issue a draft sale document: assigns the next number (from its document series,
|
|
|
11675
11501
|
<dd>
|
|
11676
11502
|
|
|
11677
11503
|
```ruby
|
|
11678
|
-
client.sales.
|
|
11504
|
+
client.sales.invoices_update(id: "id")
|
|
11679
11505
|
```
|
|
11680
11506
|
</dd>
|
|
11681
11507
|
</dl>
|
|
@@ -11698,7 +11524,7 @@ client.sales.invoices_issue(id: "id")
|
|
|
11698
11524
|
<dl>
|
|
11699
11525
|
<dd>
|
|
11700
11526
|
|
|
11701
|
-
**
|
|
11527
|
+
**partner_id:** `String`
|
|
11702
11528
|
|
|
11703
11529
|
</dd>
|
|
11704
11530
|
</dl>
|
|
@@ -11706,7 +11532,7 @@ client.sales.invoices_issue(id: "id")
|
|
|
11706
11532
|
<dl>
|
|
11707
11533
|
<dd>
|
|
11708
11534
|
|
|
11709
|
-
**
|
|
11535
|
+
**agreement_id:** `String`
|
|
11710
11536
|
|
|
11711
11537
|
</dd>
|
|
11712
11538
|
</dl>
|
|
@@ -11714,7 +11540,7 @@ client.sales.invoices_issue(id: "id")
|
|
|
11714
11540
|
<dl>
|
|
11715
11541
|
<dd>
|
|
11716
11542
|
|
|
11717
|
-
**
|
|
11543
|
+
**currency:** `String`
|
|
11718
11544
|
|
|
11719
11545
|
</dd>
|
|
11720
11546
|
</dl>
|
|
@@ -11722,7 +11548,7 @@ client.sales.invoices_issue(id: "id")
|
|
|
11722
11548
|
<dl>
|
|
11723
11549
|
<dd>
|
|
11724
11550
|
|
|
11725
|
-
**
|
|
11551
|
+
**issue_date:** `String`
|
|
11726
11552
|
|
|
11727
11553
|
</dd>
|
|
11728
11554
|
</dl>
|
|
@@ -11730,61 +11556,87 @@ client.sales.invoices_issue(id: "id")
|
|
|
11730
11556
|
<dl>
|
|
11731
11557
|
<dd>
|
|
11732
11558
|
|
|
11733
|
-
**
|
|
11559
|
+
**due_date:** `String`
|
|
11734
11560
|
|
|
11735
11561
|
</dd>
|
|
11736
11562
|
</dl>
|
|
11737
|
-
</dd>
|
|
11738
|
-
</dl>
|
|
11739
11563
|
|
|
11564
|
+
<dl>
|
|
11565
|
+
<dd>
|
|
11740
11566
|
|
|
11567
|
+
**vat_scheme:** `Nordlet::Sales::Types::InvoicesUpdateSalesRequestVatScheme`
|
|
11568
|
+
|
|
11741
11569
|
</dd>
|
|
11742
11570
|
</dl>
|
|
11743
|
-
</details>
|
|
11744
11571
|
|
|
11745
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_lock</a>(request) -> Nordlet::Sales::Types::InvoicesLockSalesResponse</code></summary>
|
|
11746
11572
|
<dl>
|
|
11747
11573
|
<dd>
|
|
11748
11574
|
|
|
11749
|
-
|
|
11575
|
+
**intrastat_transport_mode:** `String`
|
|
11576
|
+
|
|
11577
|
+
</dd>
|
|
11578
|
+
</dl>
|
|
11750
11579
|
|
|
11751
11580
|
<dl>
|
|
11752
11581
|
<dd>
|
|
11753
11582
|
|
|
11583
|
+
**intrastat_delivery_terms:** `String`
|
|
11584
|
+
|
|
11585
|
+
</dd>
|
|
11586
|
+
</dl>
|
|
11587
|
+
|
|
11754
11588
|
<dl>
|
|
11755
11589
|
<dd>
|
|
11756
11590
|
|
|
11757
|
-
|
|
11591
|
+
**intrastat_region:** `String`
|
|
11592
|
+
|
|
11758
11593
|
</dd>
|
|
11759
11594
|
</dl>
|
|
11595
|
+
|
|
11596
|
+
<dl>
|
|
11597
|
+
<dd>
|
|
11598
|
+
|
|
11599
|
+
**intrastat_nature_of_transaction:** `String`
|
|
11600
|
+
|
|
11760
11601
|
</dd>
|
|
11761
11602
|
</dl>
|
|
11762
11603
|
|
|
11763
|
-
#### 🔌 Usage
|
|
11764
|
-
|
|
11765
11604
|
<dl>
|
|
11766
11605
|
<dd>
|
|
11767
11606
|
|
|
11607
|
+
**vat_country_code:** `String`
|
|
11608
|
+
|
|
11609
|
+
</dd>
|
|
11610
|
+
</dl>
|
|
11611
|
+
|
|
11768
11612
|
<dl>
|
|
11769
11613
|
<dd>
|
|
11770
11614
|
|
|
11771
|
-
|
|
11772
|
-
|
|
11773
|
-
```
|
|
11615
|
+
**deemed_supplier:** `Internal::Types::Boolean`
|
|
11616
|
+
|
|
11774
11617
|
</dd>
|
|
11775
11618
|
</dl>
|
|
11619
|
+
|
|
11620
|
+
<dl>
|
|
11621
|
+
<dd>
|
|
11622
|
+
|
|
11623
|
+
**notes:** `String`
|
|
11624
|
+
|
|
11776
11625
|
</dd>
|
|
11777
11626
|
</dl>
|
|
11778
11627
|
|
|
11779
|
-
#### ⚙️ Parameters
|
|
11780
|
-
|
|
11781
11628
|
<dl>
|
|
11782
11629
|
<dd>
|
|
11783
11630
|
|
|
11631
|
+
**locale:** `Nordlet::Sales::Types::InvoicesUpdateSalesRequestLocale`
|
|
11632
|
+
|
|
11633
|
+
</dd>
|
|
11634
|
+
</dl>
|
|
11635
|
+
|
|
11784
11636
|
<dl>
|
|
11785
11637
|
<dd>
|
|
11786
11638
|
|
|
11787
|
-
**
|
|
11639
|
+
**pay_link_enabled:** `Internal::Types::Boolean`
|
|
11788
11640
|
|
|
11789
11641
|
</dd>
|
|
11790
11642
|
</dl>
|
|
@@ -11792,61 +11644,95 @@ client.sales.invoices_lock(id: "id")
|
|
|
11792
11644
|
<dl>
|
|
11793
11645
|
<dd>
|
|
11794
11646
|
|
|
11795
|
-
**
|
|
11647
|
+
**debt_reminders_enabled:** `Internal::Types::Boolean`
|
|
11796
11648
|
|
|
11797
11649
|
</dd>
|
|
11798
11650
|
</dl>
|
|
11651
|
+
|
|
11652
|
+
<dl>
|
|
11653
|
+
<dd>
|
|
11654
|
+
|
|
11655
|
+
**operation_type_id:** `String`
|
|
11656
|
+
|
|
11799
11657
|
</dd>
|
|
11800
11658
|
</dl>
|
|
11801
11659
|
|
|
11660
|
+
<dl>
|
|
11661
|
+
<dd>
|
|
11802
11662
|
|
|
11663
|
+
**document_series_id:** `String`
|
|
11664
|
+
|
|
11803
11665
|
</dd>
|
|
11804
11666
|
</dl>
|
|
11805
|
-
</details>
|
|
11806
11667
|
|
|
11807
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_unlock</a>(request) -> Nordlet::Sales::Types::InvoicesUnlockSalesResponse</code></summary>
|
|
11808
11668
|
<dl>
|
|
11809
11669
|
<dd>
|
|
11810
11670
|
|
|
11811
|
-
|
|
11671
|
+
**series_label:** `String`
|
|
11672
|
+
|
|
11673
|
+
</dd>
|
|
11674
|
+
</dl>
|
|
11812
11675
|
|
|
11813
11676
|
<dl>
|
|
11814
11677
|
<dd>
|
|
11815
11678
|
|
|
11679
|
+
**discount_percent:** `String`
|
|
11680
|
+
|
|
11681
|
+
</dd>
|
|
11682
|
+
</dl>
|
|
11683
|
+
|
|
11816
11684
|
<dl>
|
|
11817
11685
|
<dd>
|
|
11818
11686
|
|
|
11819
|
-
|
|
11687
|
+
**order_number:** `String`
|
|
11688
|
+
|
|
11820
11689
|
</dd>
|
|
11821
11690
|
</dl>
|
|
11691
|
+
|
|
11692
|
+
<dl>
|
|
11693
|
+
<dd>
|
|
11694
|
+
|
|
11695
|
+
**issued_by_name:** `String`
|
|
11696
|
+
|
|
11822
11697
|
</dd>
|
|
11823
11698
|
</dl>
|
|
11824
11699
|
|
|
11825
|
-
#### 🔌 Usage
|
|
11826
|
-
|
|
11827
11700
|
<dl>
|
|
11828
11701
|
<dd>
|
|
11829
11702
|
|
|
11703
|
+
**issued_by_title:** `String`
|
|
11704
|
+
|
|
11705
|
+
</dd>
|
|
11706
|
+
</dl>
|
|
11707
|
+
|
|
11830
11708
|
<dl>
|
|
11831
11709
|
<dd>
|
|
11832
11710
|
|
|
11833
|
-
|
|
11834
|
-
|
|
11835
|
-
```
|
|
11711
|
+
**received_by_name:** `String`
|
|
11712
|
+
|
|
11836
11713
|
</dd>
|
|
11837
11714
|
</dl>
|
|
11715
|
+
|
|
11716
|
+
<dl>
|
|
11717
|
+
<dd>
|
|
11718
|
+
|
|
11719
|
+
**received_by_title:** `String`
|
|
11720
|
+
|
|
11838
11721
|
</dd>
|
|
11839
11722
|
</dl>
|
|
11840
11723
|
|
|
11841
|
-
#### ⚙️ Parameters
|
|
11842
|
-
|
|
11843
11724
|
<dl>
|
|
11844
11725
|
<dd>
|
|
11845
11726
|
|
|
11727
|
+
**sales_tax_percent:** `String`
|
|
11728
|
+
|
|
11729
|
+
</dd>
|
|
11730
|
+
</dl>
|
|
11731
|
+
|
|
11846
11732
|
<dl>
|
|
11847
11733
|
<dd>
|
|
11848
11734
|
|
|
11849
|
-
**
|
|
11735
|
+
**lines:** `Internal::Types::Array[Nordlet::Sales::Types::InvoicesUpdateSalesRequestLinesItem]`
|
|
11850
11736
|
|
|
11851
11737
|
</dd>
|
|
11852
11738
|
</dl>
|
|
@@ -11866,7 +11752,7 @@ client.sales.invoices_unlock(id: "id")
|
|
|
11866
11752
|
</dl>
|
|
11867
11753
|
</details>
|
|
11868
11754
|
|
|
11869
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
11755
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_delete</a>(request) -> Nordlet::Sales::Types::InvoicesDeleteSalesResponse</code></summary>
|
|
11870
11756
|
<dl>
|
|
11871
11757
|
<dd>
|
|
11872
11758
|
|
|
@@ -11878,7 +11764,7 @@ client.sales.invoices_unlock(id: "id")
|
|
|
11878
11764
|
<dl>
|
|
11879
11765
|
<dd>
|
|
11880
11766
|
|
|
11881
|
-
|
|
11767
|
+
Delete a draft sale document and release the time entries billed on it. Answers 409 when the document is issued (credit it instead) or locked.
|
|
11882
11768
|
</dd>
|
|
11883
11769
|
</dl>
|
|
11884
11770
|
</dd>
|
|
@@ -11893,7 +11779,287 @@ Return the customer payment link of a sale document, rendered from the company's
|
|
|
11893
11779
|
<dd>
|
|
11894
11780
|
|
|
11895
11781
|
```ruby
|
|
11896
|
-
client.sales.
|
|
11782
|
+
client.sales.invoices_delete(id: "id")
|
|
11783
|
+
```
|
|
11784
|
+
</dd>
|
|
11785
|
+
</dl>
|
|
11786
|
+
</dd>
|
|
11787
|
+
</dl>
|
|
11788
|
+
|
|
11789
|
+
#### ⚙️ Parameters
|
|
11790
|
+
|
|
11791
|
+
<dl>
|
|
11792
|
+
<dd>
|
|
11793
|
+
|
|
11794
|
+
<dl>
|
|
11795
|
+
<dd>
|
|
11796
|
+
|
|
11797
|
+
**id:** `String`
|
|
11798
|
+
|
|
11799
|
+
</dd>
|
|
11800
|
+
</dl>
|
|
11801
|
+
|
|
11802
|
+
<dl>
|
|
11803
|
+
<dd>
|
|
11804
|
+
|
|
11805
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
11806
|
+
|
|
11807
|
+
</dd>
|
|
11808
|
+
</dl>
|
|
11809
|
+
</dd>
|
|
11810
|
+
</dl>
|
|
11811
|
+
|
|
11812
|
+
|
|
11813
|
+
</dd>
|
|
11814
|
+
</dl>
|
|
11815
|
+
</details>
|
|
11816
|
+
|
|
11817
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_issue</a>(request) -> Nordlet::Sales::Types::InvoicesIssueSalesResponse</code></summary>
|
|
11818
|
+
<dl>
|
|
11819
|
+
<dd>
|
|
11820
|
+
|
|
11821
|
+
#### 📝 Description
|
|
11822
|
+
|
|
11823
|
+
<dl>
|
|
11824
|
+
<dd>
|
|
11825
|
+
|
|
11826
|
+
<dl>
|
|
11827
|
+
<dd>
|
|
11828
|
+
|
|
11829
|
+
Issue a draft sale document: assigns the next number (from its document series, else from `series` or the type's default prefix and the year), the issue date (`issueDate`, else the draft's, else today) and a missing due date from the partner's payment term, and for an invoice, credit note or advance invoice posts the journal entry and stores the VAT evidence. `warehouseId` (or the series' warehouse) takes the sold goods of an invoice out of stock with a cost of goods sold entry; `returnToStock` puts them back for a credit note that credits an invoice. A credit note is set against the unpaid balance of the credited document. Emits `sale_invoice.issued`, `sale_invoice.paid` when a credit note settles the credited invoice in full, and `intercompany.invoice_mirrored` when the partner is linked to another company of the group (a draft purchase invoice is created there). Answers 409 when the document is already issued or locked or the accounting period is locked, 422 when the lines carry VAT under a scheme that charges none, when credit notes would exceed the credited total, or when `returnToStock` is used on anything but a credit note of an invoice.
|
|
11830
|
+
</dd>
|
|
11831
|
+
</dl>
|
|
11832
|
+
</dd>
|
|
11833
|
+
</dl>
|
|
11834
|
+
|
|
11835
|
+
#### 🔌 Usage
|
|
11836
|
+
|
|
11837
|
+
<dl>
|
|
11838
|
+
<dd>
|
|
11839
|
+
|
|
11840
|
+
<dl>
|
|
11841
|
+
<dd>
|
|
11842
|
+
|
|
11843
|
+
```ruby
|
|
11844
|
+
client.sales.invoices_issue(id: "id")
|
|
11845
|
+
```
|
|
11846
|
+
</dd>
|
|
11847
|
+
</dl>
|
|
11848
|
+
</dd>
|
|
11849
|
+
</dl>
|
|
11850
|
+
|
|
11851
|
+
#### ⚙️ Parameters
|
|
11852
|
+
|
|
11853
|
+
<dl>
|
|
11854
|
+
<dd>
|
|
11855
|
+
|
|
11856
|
+
<dl>
|
|
11857
|
+
<dd>
|
|
11858
|
+
|
|
11859
|
+
**id:** `String`
|
|
11860
|
+
|
|
11861
|
+
</dd>
|
|
11862
|
+
</dl>
|
|
11863
|
+
|
|
11864
|
+
<dl>
|
|
11865
|
+
<dd>
|
|
11866
|
+
|
|
11867
|
+
**series:** `String`
|
|
11868
|
+
|
|
11869
|
+
</dd>
|
|
11870
|
+
</dl>
|
|
11871
|
+
|
|
11872
|
+
<dl>
|
|
11873
|
+
<dd>
|
|
11874
|
+
|
|
11875
|
+
**issue_date:** `String`
|
|
11876
|
+
|
|
11877
|
+
</dd>
|
|
11878
|
+
</dl>
|
|
11879
|
+
|
|
11880
|
+
<dl>
|
|
11881
|
+
<dd>
|
|
11882
|
+
|
|
11883
|
+
**warehouse_id:** `String`
|
|
11884
|
+
|
|
11885
|
+
</dd>
|
|
11886
|
+
</dl>
|
|
11887
|
+
|
|
11888
|
+
<dl>
|
|
11889
|
+
<dd>
|
|
11890
|
+
|
|
11891
|
+
**return_to_stock:** `Internal::Types::Boolean`
|
|
11892
|
+
|
|
11893
|
+
</dd>
|
|
11894
|
+
</dl>
|
|
11895
|
+
|
|
11896
|
+
<dl>
|
|
11897
|
+
<dd>
|
|
11898
|
+
|
|
11899
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
11900
|
+
|
|
11901
|
+
</dd>
|
|
11902
|
+
</dl>
|
|
11903
|
+
</dd>
|
|
11904
|
+
</dl>
|
|
11905
|
+
|
|
11906
|
+
|
|
11907
|
+
</dd>
|
|
11908
|
+
</dl>
|
|
11909
|
+
</details>
|
|
11910
|
+
|
|
11911
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_lock</a>(request) -> Nordlet::Sales::Types::InvoicesLockSalesResponse</code></summary>
|
|
11912
|
+
<dl>
|
|
11913
|
+
<dd>
|
|
11914
|
+
|
|
11915
|
+
#### 📝 Description
|
|
11916
|
+
|
|
11917
|
+
<dl>
|
|
11918
|
+
<dd>
|
|
11919
|
+
|
|
11920
|
+
<dl>
|
|
11921
|
+
<dd>
|
|
11922
|
+
|
|
11923
|
+
Lock a sale document. A locked document is refused with 409 by `sales/invoices/update`, `sales/invoices/delete`, `sales/invoices/issue` and `sales/invoices/apply-advance` until `sales/invoices/unlock`.
|
|
11924
|
+
</dd>
|
|
11925
|
+
</dl>
|
|
11926
|
+
</dd>
|
|
11927
|
+
</dl>
|
|
11928
|
+
|
|
11929
|
+
#### 🔌 Usage
|
|
11930
|
+
|
|
11931
|
+
<dl>
|
|
11932
|
+
<dd>
|
|
11933
|
+
|
|
11934
|
+
<dl>
|
|
11935
|
+
<dd>
|
|
11936
|
+
|
|
11937
|
+
```ruby
|
|
11938
|
+
client.sales.invoices_lock(id: "id")
|
|
11939
|
+
```
|
|
11940
|
+
</dd>
|
|
11941
|
+
</dl>
|
|
11942
|
+
</dd>
|
|
11943
|
+
</dl>
|
|
11944
|
+
|
|
11945
|
+
#### ⚙️ Parameters
|
|
11946
|
+
|
|
11947
|
+
<dl>
|
|
11948
|
+
<dd>
|
|
11949
|
+
|
|
11950
|
+
<dl>
|
|
11951
|
+
<dd>
|
|
11952
|
+
|
|
11953
|
+
**id:** `String`
|
|
11954
|
+
|
|
11955
|
+
</dd>
|
|
11956
|
+
</dl>
|
|
11957
|
+
|
|
11958
|
+
<dl>
|
|
11959
|
+
<dd>
|
|
11960
|
+
|
|
11961
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
11962
|
+
|
|
11963
|
+
</dd>
|
|
11964
|
+
</dl>
|
|
11965
|
+
</dd>
|
|
11966
|
+
</dl>
|
|
11967
|
+
|
|
11968
|
+
|
|
11969
|
+
</dd>
|
|
11970
|
+
</dl>
|
|
11971
|
+
</details>
|
|
11972
|
+
|
|
11973
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_unlock</a>(request) -> Nordlet::Sales::Types::InvoicesUnlockSalesResponse</code></summary>
|
|
11974
|
+
<dl>
|
|
11975
|
+
<dd>
|
|
11976
|
+
|
|
11977
|
+
#### 📝 Description
|
|
11978
|
+
|
|
11979
|
+
<dl>
|
|
11980
|
+
<dd>
|
|
11981
|
+
|
|
11982
|
+
<dl>
|
|
11983
|
+
<dd>
|
|
11984
|
+
|
|
11985
|
+
Unlock a sale document locked with `sales/invoices/lock`.
|
|
11986
|
+
</dd>
|
|
11987
|
+
</dl>
|
|
11988
|
+
</dd>
|
|
11989
|
+
</dl>
|
|
11990
|
+
|
|
11991
|
+
#### 🔌 Usage
|
|
11992
|
+
|
|
11993
|
+
<dl>
|
|
11994
|
+
<dd>
|
|
11995
|
+
|
|
11996
|
+
<dl>
|
|
11997
|
+
<dd>
|
|
11998
|
+
|
|
11999
|
+
```ruby
|
|
12000
|
+
client.sales.invoices_unlock(id: "id")
|
|
12001
|
+
```
|
|
12002
|
+
</dd>
|
|
12003
|
+
</dl>
|
|
12004
|
+
</dd>
|
|
12005
|
+
</dl>
|
|
12006
|
+
|
|
12007
|
+
#### ⚙️ Parameters
|
|
12008
|
+
|
|
12009
|
+
<dl>
|
|
12010
|
+
<dd>
|
|
12011
|
+
|
|
12012
|
+
<dl>
|
|
12013
|
+
<dd>
|
|
12014
|
+
|
|
12015
|
+
**id:** `String`
|
|
12016
|
+
|
|
12017
|
+
</dd>
|
|
12018
|
+
</dl>
|
|
12019
|
+
|
|
12020
|
+
<dl>
|
|
12021
|
+
<dd>
|
|
12022
|
+
|
|
12023
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
12024
|
+
|
|
12025
|
+
</dd>
|
|
12026
|
+
</dl>
|
|
12027
|
+
</dd>
|
|
12028
|
+
</dl>
|
|
12029
|
+
|
|
12030
|
+
|
|
12031
|
+
</dd>
|
|
12032
|
+
</dl>
|
|
12033
|
+
</details>
|
|
12034
|
+
|
|
12035
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_payment_link</a>(request) -> Nordlet::Sales::Types::InvoicesPaymentLinkSalesResponse</code></summary>
|
|
12036
|
+
<dl>
|
|
12037
|
+
<dd>
|
|
12038
|
+
|
|
12039
|
+
#### 📝 Description
|
|
12040
|
+
|
|
12041
|
+
<dl>
|
|
12042
|
+
<dd>
|
|
12043
|
+
|
|
12044
|
+
<dl>
|
|
12045
|
+
<dd>
|
|
12046
|
+
|
|
12047
|
+
Return the customer payment link of a sale document: the Stripe card payment page (`source` `stripe`) when the company's Stripe account is connected and can take charges (`sales/invoices/card-payments/get`), else the link rendered from the company's payment link template (`sales/invoices/payment-settings/update`, `source` `template`); `url` is null when the company has neither, the document is not issued or its `payLinkEnabled` is false. The document's payment token is created on first use. Answers 409 when the document is already paid.
|
|
12048
|
+
</dd>
|
|
12049
|
+
</dl>
|
|
12050
|
+
</dd>
|
|
12051
|
+
</dl>
|
|
12052
|
+
|
|
12053
|
+
#### 🔌 Usage
|
|
12054
|
+
|
|
12055
|
+
<dl>
|
|
12056
|
+
<dd>
|
|
12057
|
+
|
|
12058
|
+
<dl>
|
|
12059
|
+
<dd>
|
|
12060
|
+
|
|
12061
|
+
```ruby
|
|
12062
|
+
client.sales.invoices_payment_link(id: "id")
|
|
11897
12063
|
```
|
|
11898
12064
|
</dd>
|
|
11899
12065
|
</dl>
|
|
@@ -14963,6 +15129,349 @@ client.sales.refund_liability_true_up(
|
|
|
14963
15129
|
</dl>
|
|
14964
15130
|
|
|
14965
15131
|
|
|
15132
|
+
</dd>
|
|
15133
|
+
</dl>
|
|
15134
|
+
</details>
|
|
15135
|
+
|
|
15136
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">payments_list</a>(request) -> Nordlet::Sales::Types::PaymentsListSalesResponse</code></summary>
|
|
15137
|
+
<dl>
|
|
15138
|
+
<dd>
|
|
15139
|
+
|
|
15140
|
+
#### 📝 Description
|
|
15141
|
+
|
|
15142
|
+
<dl>
|
|
15143
|
+
<dd>
|
|
15144
|
+
|
|
15145
|
+
<dl>
|
|
15146
|
+
<dd>
|
|
15147
|
+
|
|
15148
|
+
List the money received on sale documents between `from` and `to` (inclusive), oldest first: bank payments matched to the document, card settlements of a payment provider and cash receipt orders. A reversed bank match is a row with a negative amount on the date it was reversed. Credit notes, advances applied to a final invoice and balances carried over by a migration are not money received and are left out. `amount` is in the document currency; `method` is `card` for a settlement or a payment into a Stripe bank account, `cash` for a cash order and `bank_transfer` otherwise.
|
|
15149
|
+
</dd>
|
|
15150
|
+
</dl>
|
|
15151
|
+
</dd>
|
|
15152
|
+
</dl>
|
|
15153
|
+
|
|
15154
|
+
#### 🔌 Usage
|
|
15155
|
+
|
|
15156
|
+
<dl>
|
|
15157
|
+
<dd>
|
|
15158
|
+
|
|
15159
|
+
<dl>
|
|
15160
|
+
<dd>
|
|
15161
|
+
|
|
15162
|
+
```ruby
|
|
15163
|
+
client.sales.payments_list(
|
|
15164
|
+
from: "2026-07-01",
|
|
15165
|
+
to: "2026-07-01"
|
|
15166
|
+
)
|
|
15167
|
+
```
|
|
15168
|
+
</dd>
|
|
15169
|
+
</dl>
|
|
15170
|
+
</dd>
|
|
15171
|
+
</dl>
|
|
15172
|
+
|
|
15173
|
+
#### ⚙️ Parameters
|
|
15174
|
+
|
|
15175
|
+
<dl>
|
|
15176
|
+
<dd>
|
|
15177
|
+
|
|
15178
|
+
<dl>
|
|
15179
|
+
<dd>
|
|
15180
|
+
|
|
15181
|
+
**from:** `String`
|
|
15182
|
+
|
|
15183
|
+
</dd>
|
|
15184
|
+
</dl>
|
|
15185
|
+
|
|
15186
|
+
<dl>
|
|
15187
|
+
<dd>
|
|
15188
|
+
|
|
15189
|
+
**to:** `String`
|
|
15190
|
+
|
|
15191
|
+
</dd>
|
|
15192
|
+
</dl>
|
|
15193
|
+
|
|
15194
|
+
<dl>
|
|
15195
|
+
<dd>
|
|
15196
|
+
|
|
15197
|
+
**page:** `Integer`
|
|
15198
|
+
|
|
15199
|
+
</dd>
|
|
15200
|
+
</dl>
|
|
15201
|
+
|
|
15202
|
+
<dl>
|
|
15203
|
+
<dd>
|
|
15204
|
+
|
|
15205
|
+
**page_size:** `Integer`
|
|
15206
|
+
|
|
15207
|
+
</dd>
|
|
15208
|
+
</dl>
|
|
15209
|
+
|
|
15210
|
+
<dl>
|
|
15211
|
+
<dd>
|
|
15212
|
+
|
|
15213
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
15214
|
+
|
|
15215
|
+
</dd>
|
|
15216
|
+
</dl>
|
|
15217
|
+
</dd>
|
|
15218
|
+
</dl>
|
|
15219
|
+
|
|
15220
|
+
|
|
15221
|
+
</dd>
|
|
15222
|
+
</dl>
|
|
15223
|
+
</details>
|
|
15224
|
+
|
|
15225
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">exports_month</a>(request) -> Nordlet::Sales::Types::ExportsMonthSalesResponse</code></summary>
|
|
15226
|
+
<dl>
|
|
15227
|
+
<dd>
|
|
15228
|
+
|
|
15229
|
+
#### 📝 Description
|
|
15230
|
+
|
|
15231
|
+
<dl>
|
|
15232
|
+
<dd>
|
|
15233
|
+
|
|
15234
|
+
<dl>
|
|
15235
|
+
<dd>
|
|
15236
|
+
|
|
15237
|
+
Export one calendar month for the accountant as a single file: every invoice and credit note issued in the month (number, dates, client, currency, net, VAT, total and the amount paid so far) and every payment received in the month as listed by `sales/payments/list`. `format` is `csv` (comma separated, UTF-8, one section per table) or `pdf`. `format` `nordlet` instead returns a JSON package that `migration/books/validate` and `migration/books/import` accept: every posted journal transaction dated in the month with its debit and credit lines, the accounts those lines use (with their parent accounts) and the partners of those transactions; its cutoverDate is the day after the month ends. The file comes back base64-encoded in `data`.
|
|
15238
|
+
</dd>
|
|
15239
|
+
</dl>
|
|
15240
|
+
</dd>
|
|
15241
|
+
</dl>
|
|
15242
|
+
|
|
15243
|
+
#### 🔌 Usage
|
|
15244
|
+
|
|
15245
|
+
<dl>
|
|
15246
|
+
<dd>
|
|
15247
|
+
|
|
15248
|
+
<dl>
|
|
15249
|
+
<dd>
|
|
15250
|
+
|
|
15251
|
+
```ruby
|
|
15252
|
+
client.sales.exports_month(
|
|
15253
|
+
month: "month",
|
|
15254
|
+
format: "csv"
|
|
15255
|
+
)
|
|
15256
|
+
```
|
|
15257
|
+
</dd>
|
|
15258
|
+
</dl>
|
|
15259
|
+
</dd>
|
|
15260
|
+
</dl>
|
|
15261
|
+
|
|
15262
|
+
#### ⚙️ Parameters
|
|
15263
|
+
|
|
15264
|
+
<dl>
|
|
15265
|
+
<dd>
|
|
15266
|
+
|
|
15267
|
+
<dl>
|
|
15268
|
+
<dd>
|
|
15269
|
+
|
|
15270
|
+
**month:** `String`
|
|
15271
|
+
|
|
15272
|
+
</dd>
|
|
15273
|
+
</dl>
|
|
15274
|
+
|
|
15275
|
+
<dl>
|
|
15276
|
+
<dd>
|
|
15277
|
+
|
|
15278
|
+
**format:** `Nordlet::Sales::Types::ExportsMonthSalesRequestFormat`
|
|
15279
|
+
|
|
15280
|
+
</dd>
|
|
15281
|
+
</dl>
|
|
15282
|
+
|
|
15283
|
+
<dl>
|
|
15284
|
+
<dd>
|
|
15285
|
+
|
|
15286
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
15287
|
+
|
|
15288
|
+
</dd>
|
|
15289
|
+
</dl>
|
|
15290
|
+
</dd>
|
|
15291
|
+
</dl>
|
|
15292
|
+
|
|
15293
|
+
|
|
15294
|
+
</dd>
|
|
15295
|
+
</dl>
|
|
15296
|
+
</details>
|
|
15297
|
+
|
|
15298
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_card_payments_get</a>(request) -> Nordlet::Sales::Types::InvoicesCardPaymentsGetSalesResponse</code></summary>
|
|
15299
|
+
<dl>
|
|
15300
|
+
<dd>
|
|
15301
|
+
|
|
15302
|
+
#### 📝 Description
|
|
15303
|
+
|
|
15304
|
+
<dl>
|
|
15305
|
+
<dd>
|
|
15306
|
+
|
|
15307
|
+
<dl>
|
|
15308
|
+
<dd>
|
|
15309
|
+
|
|
15310
|
+
Return whether the company's Stripe account is connected for card payments and whether Stripe lets it take charges yet. While the account is connected but cannot take charges, Stripe is asked again on each call. When `chargesEnabled` is true, payment links of issued invoices open a Stripe Checkout page on that account.
|
|
15311
|
+
</dd>
|
|
15312
|
+
</dl>
|
|
15313
|
+
</dd>
|
|
15314
|
+
</dl>
|
|
15315
|
+
|
|
15316
|
+
#### 🔌 Usage
|
|
15317
|
+
|
|
15318
|
+
<dl>
|
|
15319
|
+
<dd>
|
|
15320
|
+
|
|
15321
|
+
<dl>
|
|
15322
|
+
<dd>
|
|
15323
|
+
|
|
15324
|
+
```ruby
|
|
15325
|
+
client.sales.invoices_card_payments_get
|
|
15326
|
+
```
|
|
15327
|
+
</dd>
|
|
15328
|
+
</dl>
|
|
15329
|
+
</dd>
|
|
15330
|
+
</dl>
|
|
15331
|
+
|
|
15332
|
+
#### ⚙️ Parameters
|
|
15333
|
+
|
|
15334
|
+
<dl>
|
|
15335
|
+
<dd>
|
|
15336
|
+
|
|
15337
|
+
<dl>
|
|
15338
|
+
<dd>
|
|
15339
|
+
|
|
15340
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
15341
|
+
|
|
15342
|
+
</dd>
|
|
15343
|
+
</dl>
|
|
15344
|
+
</dd>
|
|
15345
|
+
</dl>
|
|
15346
|
+
|
|
15347
|
+
|
|
15348
|
+
</dd>
|
|
15349
|
+
</dl>
|
|
15350
|
+
</details>
|
|
15351
|
+
|
|
15352
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_card_payments_connect</a>(request) -> Nordlet::Sales::Types::InvoicesCardPaymentsConnectSalesResponse</code></summary>
|
|
15353
|
+
<dl>
|
|
15354
|
+
<dd>
|
|
15355
|
+
|
|
15356
|
+
#### 📝 Description
|
|
15357
|
+
|
|
15358
|
+
<dl>
|
|
15359
|
+
<dd>
|
|
15360
|
+
|
|
15361
|
+
<dl>
|
|
15362
|
+
<dd>
|
|
15363
|
+
|
|
15364
|
+
Start or continue connecting the company's own Stripe account for card payments: creates the Stripe account on first use and returns the Stripe-hosted onboarding `url`. Stripe sends the user back to `returnUrl` when onboarding ends and to `refreshUrl` when the link has expired. Answers 503 when Stripe is not configured.
|
|
15365
|
+
</dd>
|
|
15366
|
+
</dl>
|
|
15367
|
+
</dd>
|
|
15368
|
+
</dl>
|
|
15369
|
+
|
|
15370
|
+
#### 🔌 Usage
|
|
15371
|
+
|
|
15372
|
+
<dl>
|
|
15373
|
+
<dd>
|
|
15374
|
+
|
|
15375
|
+
<dl>
|
|
15376
|
+
<dd>
|
|
15377
|
+
|
|
15378
|
+
```ruby
|
|
15379
|
+
client.sales.invoices_card_payments_connect(
|
|
15380
|
+
return_url: "returnUrl",
|
|
15381
|
+
refresh_url: "refreshUrl"
|
|
15382
|
+
)
|
|
15383
|
+
```
|
|
15384
|
+
</dd>
|
|
15385
|
+
</dl>
|
|
15386
|
+
</dd>
|
|
15387
|
+
</dl>
|
|
15388
|
+
|
|
15389
|
+
#### ⚙️ Parameters
|
|
15390
|
+
|
|
15391
|
+
<dl>
|
|
15392
|
+
<dd>
|
|
15393
|
+
|
|
15394
|
+
<dl>
|
|
15395
|
+
<dd>
|
|
15396
|
+
|
|
15397
|
+
**return_url:** `String`
|
|
15398
|
+
|
|
15399
|
+
</dd>
|
|
15400
|
+
</dl>
|
|
15401
|
+
|
|
15402
|
+
<dl>
|
|
15403
|
+
<dd>
|
|
15404
|
+
|
|
15405
|
+
**refresh_url:** `String`
|
|
15406
|
+
|
|
15407
|
+
</dd>
|
|
15408
|
+
</dl>
|
|
15409
|
+
|
|
15410
|
+
<dl>
|
|
15411
|
+
<dd>
|
|
15412
|
+
|
|
15413
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
15414
|
+
|
|
15415
|
+
</dd>
|
|
15416
|
+
</dl>
|
|
15417
|
+
</dd>
|
|
15418
|
+
</dl>
|
|
15419
|
+
|
|
15420
|
+
|
|
15421
|
+
</dd>
|
|
15422
|
+
</dl>
|
|
15423
|
+
</details>
|
|
15424
|
+
|
|
15425
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_card_payments_disconnect</a>(request) -> Nordlet::Sales::Types::InvoicesCardPaymentsDisconnectSalesResponse</code></summary>
|
|
15426
|
+
<dl>
|
|
15427
|
+
<dd>
|
|
15428
|
+
|
|
15429
|
+
#### 📝 Description
|
|
15430
|
+
|
|
15431
|
+
<dl>
|
|
15432
|
+
<dd>
|
|
15433
|
+
|
|
15434
|
+
<dl>
|
|
15435
|
+
<dd>
|
|
15436
|
+
|
|
15437
|
+
Disconnect the company's Stripe account: payment links fall back to the payment link template. The Stripe account itself is left as it is.
|
|
15438
|
+
</dd>
|
|
15439
|
+
</dl>
|
|
15440
|
+
</dd>
|
|
15441
|
+
</dl>
|
|
15442
|
+
|
|
15443
|
+
#### 🔌 Usage
|
|
15444
|
+
|
|
15445
|
+
<dl>
|
|
15446
|
+
<dd>
|
|
15447
|
+
|
|
15448
|
+
<dl>
|
|
15449
|
+
<dd>
|
|
15450
|
+
|
|
15451
|
+
```ruby
|
|
15452
|
+
client.sales.invoices_card_payments_disconnect
|
|
15453
|
+
```
|
|
15454
|
+
</dd>
|
|
15455
|
+
</dl>
|
|
15456
|
+
</dd>
|
|
15457
|
+
</dl>
|
|
15458
|
+
|
|
15459
|
+
#### ⚙️ Parameters
|
|
15460
|
+
|
|
15461
|
+
<dl>
|
|
15462
|
+
<dd>
|
|
15463
|
+
|
|
15464
|
+
<dl>
|
|
15465
|
+
<dd>
|
|
15466
|
+
|
|
15467
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
15468
|
+
|
|
15469
|
+
</dd>
|
|
15470
|
+
</dl>
|
|
15471
|
+
</dd>
|
|
15472
|
+
</dl>
|
|
15473
|
+
|
|
15474
|
+
|
|
14966
15475
|
</dd>
|
|
14967
15476
|
</dl>
|
|
14968
15477
|
</details>
|
|
@@ -23432,7 +23941,7 @@ client.declarations.cy_he32generate(year: 1000000)
|
|
|
23432
23941
|
<dl>
|
|
23433
23942
|
<dd>
|
|
23434
23943
|
|
|
23435
|
-
Build one of the German returns that ELSTER accepts only through a licensed ERiC transmission (E-Bilanz, Körperschaftsteuer, Gewerbesteuer with its Zerlegungserklärung, annual VAT return, Lohnsteuer-Anmeldung, Lohnsteuerbescheinigung) for the company to send through its own ELSTER-capable program. The period is the year, or YYYY-MM for the monthly Lohnsteuer-Anmeldung.
|
|
23944
|
+
Build one of the German returns that ELSTER accepts only through a licensed ERiC transmission (E-Bilanz, Körperschaftsteuer, Gewerbesteuer with its Zerlegungserklärung, annual VAT return, Lohnsteuer-Anmeldung, Lohnsteuerbescheinigung) for the company to send through its own ELSTER-capable program, or the Anlage EÜR with the Anlage AVEÜR of a cash-basis company as a UTF-8 CSV file of its Zeilen and Kennzahlen (`de-euer`, 422 for a company without the cash-basis flag). The period is the year, or YYYY-MM for the monthly Lohnsteuer-Anmeldung.
|
|
23436
23945
|
</dd>
|
|
23437
23946
|
</dl>
|
|
23438
23947
|
</dd>
|
|
@@ -23489,6 +23998,68 @@ client.declarations.de_returns_generate(
|
|
|
23489
23998
|
</dl>
|
|
23490
23999
|
|
|
23491
24000
|
|
|
24001
|
+
</dd>
|
|
24002
|
+
</dl>
|
|
24003
|
+
</details>
|
|
24004
|
+
|
|
24005
|
+
<details><summary><code>client.declarations.<a href="/lib/nordlet/declarations/client.rb">de_euer_get</a>(request) -> Nordlet::Declarations::Types::DeEuerGetDeclarationsResponse</code></summary>
|
|
24006
|
+
<dl>
|
|
24007
|
+
<dd>
|
|
24008
|
+
|
|
24009
|
+
#### 📝 Description
|
|
24010
|
+
|
|
24011
|
+
<dl>
|
|
24012
|
+
<dd>
|
|
24013
|
+
|
|
24014
|
+
<dl>
|
|
24015
|
+
<dd>
|
|
24016
|
+
|
|
24017
|
+
The Anlage EÜR and the Anlage AVEÜR of a year for a company that determines its profit on a cash basis (§ 4 Abs. 3 EStG), as the Zeilen and Kennzahlen of the official 2025 forms with their amounts: the receipts and payments of the year from the invoice payments (each payment split over the lines of its invoice), the payroll and tax payments and the journal transactions on cash and bank accounts, and the asset register for the Anlage AVEÜR and the AfA. Accounts are placed on the Zeilen through the de-euer statement scheme (Account → Statement rows). Refused with 422 for a company without the cash-basis flag.
|
|
24018
|
+
</dd>
|
|
24019
|
+
</dl>
|
|
24020
|
+
</dd>
|
|
24021
|
+
</dl>
|
|
24022
|
+
|
|
24023
|
+
#### 🔌 Usage
|
|
24024
|
+
|
|
24025
|
+
<dl>
|
|
24026
|
+
<dd>
|
|
24027
|
+
|
|
24028
|
+
<dl>
|
|
24029
|
+
<dd>
|
|
24030
|
+
|
|
24031
|
+
```ruby
|
|
24032
|
+
client.declarations.de_euer_get(year: 1000000)
|
|
24033
|
+
```
|
|
24034
|
+
</dd>
|
|
24035
|
+
</dl>
|
|
24036
|
+
</dd>
|
|
24037
|
+
</dl>
|
|
24038
|
+
|
|
24039
|
+
#### ⚙️ Parameters
|
|
24040
|
+
|
|
24041
|
+
<dl>
|
|
24042
|
+
<dd>
|
|
24043
|
+
|
|
24044
|
+
<dl>
|
|
24045
|
+
<dd>
|
|
24046
|
+
|
|
24047
|
+
**year:** `Integer`
|
|
24048
|
+
|
|
24049
|
+
</dd>
|
|
24050
|
+
</dl>
|
|
24051
|
+
|
|
24052
|
+
<dl>
|
|
24053
|
+
<dd>
|
|
24054
|
+
|
|
24055
|
+
**request_options:** `Nordlet::Declarations::RequestOptions`
|
|
24056
|
+
|
|
24057
|
+
</dd>
|
|
24058
|
+
</dl>
|
|
24059
|
+
</dd>
|
|
24060
|
+
</dl>
|
|
24061
|
+
|
|
24062
|
+
|
|
23492
24063
|
</dd>
|
|
23493
24064
|
</dl>
|
|
23494
24065
|
</details>
|
|
@@ -23505,7 +24076,7 @@ client.declarations.de_returns_generate(
|
|
|
23505
24076
|
<dl>
|
|
23506
24077
|
<dd>
|
|
23507
24078
|
|
|
23508
|
-
The facts of one year that the German annual returns (Körperschaftsteuer, Gewerbesteuer, Umsatzsteuererklärung) need and the ledger does not hold: changes of shareholders, contracts with shareholders, the tax contribution account, loss carry-back, the donation carry-forward, the business premises with the municipalities for the apportionment of the trade tax, the land values or property tax and the participations for the trade tax additions and reductions, the foreign income per country for the Anlage AESt, the date of leaving the small-business scheme
|
|
24079
|
+
The facts of one year that the German annual returns (Körperschaftsteuer, Gewerbesteuer, Umsatzsteuererklärung) need and the ledger does not hold: changes of shareholders, contracts with shareholders, the tax contribution account, loss carry-back, the donation carry-forward, the business premises with the municipalities for the apportionment of the trade tax, the land values or property tax and the participations for the trade tax additions and reductions, the foreign income per country for the Anlage AESt, the date of leaving the small-business scheme, the Anlage UN answers of a company seated abroad and, for a cash-basis company, the kind of income and the withdrawals and contributions of the owner for the Anlage EÜR. A key that is absent has not been answered.
|
|
23509
24080
|
</dd>
|
|
23510
24081
|
</dl>
|
|
23511
24082
|
</dd>
|
|
@@ -54288,7 +54859,106 @@ client.consolidation.intercompany_report(
|
|
|
54288
54859
|
</dl>
|
|
54289
54860
|
</details>
|
|
54290
54861
|
|
|
54291
|
-
<details><summary><code>client.consolidation.<a href="/lib/nordlet/consolidation/client.rb">report</a>(request) -> Nordlet::Consolidation::Types::ReportConsolidationResponse</code></summary>
|
|
54862
|
+
<details><summary><code>client.consolidation.<a href="/lib/nordlet/consolidation/client.rb">report</a>(request) -> Nordlet::Consolidation::Types::ReportConsolidationResponse</code></summary>
|
|
54863
|
+
<dl>
|
|
54864
|
+
<dd>
|
|
54865
|
+
|
|
54866
|
+
#### 📝 Description
|
|
54867
|
+
|
|
54868
|
+
<dl>
|
|
54869
|
+
<dd>
|
|
54870
|
+
|
|
54871
|
+
<dl>
|
|
54872
|
+
<dd>
|
|
54873
|
+
|
|
54874
|
+
Consolidated financial statements of a group for a period in its presentation currency, with the consolidated trial balance and cash flow, each member's contribution and the intercompany candidates. Each member's balances are translated at the group owner's exchange rates of `toDate` and taken in full, in proportion to the ownership (`proportional`) or as an equity-method investment (`equity`); a fully consolidated member held below 100 % yields the non-controlling interest, and `eliminations` are amounts added to account codes before the statements are assembled (`balanced` tells whether they net to zero). Refused with 422 when the group has no members.
|
|
54875
|
+
</dd>
|
|
54876
|
+
</dl>
|
|
54877
|
+
</dd>
|
|
54878
|
+
</dl>
|
|
54879
|
+
|
|
54880
|
+
#### 🔌 Usage
|
|
54881
|
+
|
|
54882
|
+
<dl>
|
|
54883
|
+
<dd>
|
|
54884
|
+
|
|
54885
|
+
<dl>
|
|
54886
|
+
<dd>
|
|
54887
|
+
|
|
54888
|
+
```ruby
|
|
54889
|
+
client.consolidation.report(
|
|
54890
|
+
group_id: "groupId",
|
|
54891
|
+
from_date: "2026-07-01",
|
|
54892
|
+
to_date: "2026-07-01"
|
|
54893
|
+
)
|
|
54894
|
+
```
|
|
54895
|
+
</dd>
|
|
54896
|
+
</dl>
|
|
54897
|
+
</dd>
|
|
54898
|
+
</dl>
|
|
54899
|
+
|
|
54900
|
+
#### ⚙️ Parameters
|
|
54901
|
+
|
|
54902
|
+
<dl>
|
|
54903
|
+
<dd>
|
|
54904
|
+
|
|
54905
|
+
<dl>
|
|
54906
|
+
<dd>
|
|
54907
|
+
|
|
54908
|
+
**group_id:** `String`
|
|
54909
|
+
|
|
54910
|
+
</dd>
|
|
54911
|
+
</dl>
|
|
54912
|
+
|
|
54913
|
+
<dl>
|
|
54914
|
+
<dd>
|
|
54915
|
+
|
|
54916
|
+
**from_date:** `String`
|
|
54917
|
+
|
|
54918
|
+
</dd>
|
|
54919
|
+
</dl>
|
|
54920
|
+
|
|
54921
|
+
<dl>
|
|
54922
|
+
<dd>
|
|
54923
|
+
|
|
54924
|
+
**to_date:** `String`
|
|
54925
|
+
|
|
54926
|
+
</dd>
|
|
54927
|
+
</dl>
|
|
54928
|
+
|
|
54929
|
+
<dl>
|
|
54930
|
+
<dd>
|
|
54931
|
+
|
|
54932
|
+
**category:** `Nordlet::Consolidation::Types::ReportConsolidationRequestCategory`
|
|
54933
|
+
|
|
54934
|
+
</dd>
|
|
54935
|
+
</dl>
|
|
54936
|
+
|
|
54937
|
+
<dl>
|
|
54938
|
+
<dd>
|
|
54939
|
+
|
|
54940
|
+
**eliminations:** `Internal::Types::Array[Nordlet::Consolidation::Types::ReportConsolidationRequestEliminationsItem]`
|
|
54941
|
+
|
|
54942
|
+
</dd>
|
|
54943
|
+
</dl>
|
|
54944
|
+
|
|
54945
|
+
<dl>
|
|
54946
|
+
<dd>
|
|
54947
|
+
|
|
54948
|
+
**request_options:** `Nordlet::Consolidation::RequestOptions`
|
|
54949
|
+
|
|
54950
|
+
</dd>
|
|
54951
|
+
</dl>
|
|
54952
|
+
</dd>
|
|
54953
|
+
</dl>
|
|
54954
|
+
|
|
54955
|
+
|
|
54956
|
+
</dd>
|
|
54957
|
+
</dl>
|
|
54958
|
+
</details>
|
|
54959
|
+
|
|
54960
|
+
## public
|
|
54961
|
+
<details><summary><code>client.public.<a href="/lib/nordlet/public/client.rb">integration_requests</a>(request) -> Nordlet::Public::Types::IntegrationRequestsPublicResponse</code></summary>
|
|
54292
54962
|
<dl>
|
|
54293
54963
|
<dd>
|
|
54294
54964
|
|
|
@@ -54300,7 +54970,7 @@ client.consolidation.intercompany_report(
|
|
|
54300
54970
|
<dl>
|
|
54301
54971
|
<dd>
|
|
54302
54972
|
|
|
54303
|
-
|
|
54973
|
+
Store a request for an integration: the integration asked for and the sender's name, company, e-mail and details. When `website` is filled in, the call answers `received` without storing anything.
|
|
54304
54974
|
</dd>
|
|
54305
54975
|
</dl>
|
|
54306
54976
|
</dd>
|
|
@@ -54315,10 +54985,10 @@ Consolidated financial statements of a group for a period in its presentation cu
|
|
|
54315
54985
|
<dd>
|
|
54316
54986
|
|
|
54317
54987
|
```ruby
|
|
54318
|
-
client.
|
|
54319
|
-
|
|
54320
|
-
|
|
54321
|
-
|
|
54988
|
+
client.public.integration_requests(
|
|
54989
|
+
integration: "integration",
|
|
54990
|
+
name: "name",
|
|
54991
|
+
email: "email"
|
|
54322
54992
|
)
|
|
54323
54993
|
```
|
|
54324
54994
|
</dd>
|
|
@@ -54334,7 +55004,7 @@ client.consolidation.report(
|
|
|
54334
55004
|
<dl>
|
|
54335
55005
|
<dd>
|
|
54336
55006
|
|
|
54337
|
-
**
|
|
55007
|
+
**integration:** `String`
|
|
54338
55008
|
|
|
54339
55009
|
</dd>
|
|
54340
55010
|
</dl>
|
|
@@ -54342,7 +55012,7 @@ client.consolidation.report(
|
|
|
54342
55012
|
<dl>
|
|
54343
55013
|
<dd>
|
|
54344
55014
|
|
|
54345
|
-
**
|
|
55015
|
+
**name:** `String`
|
|
54346
55016
|
|
|
54347
55017
|
</dd>
|
|
54348
55018
|
</dl>
|
|
@@ -54350,7 +55020,7 @@ client.consolidation.report(
|
|
|
54350
55020
|
<dl>
|
|
54351
55021
|
<dd>
|
|
54352
55022
|
|
|
54353
|
-
**
|
|
55023
|
+
**company:** `String`
|
|
54354
55024
|
|
|
54355
55025
|
</dd>
|
|
54356
55026
|
</dl>
|
|
@@ -54358,7 +55028,7 @@ client.consolidation.report(
|
|
|
54358
55028
|
<dl>
|
|
54359
55029
|
<dd>
|
|
54360
55030
|
|
|
54361
|
-
**
|
|
55031
|
+
**email:** `String`
|
|
54362
55032
|
|
|
54363
55033
|
</dd>
|
|
54364
55034
|
</dl>
|
|
@@ -54366,7 +55036,7 @@ client.consolidation.report(
|
|
|
54366
55036
|
<dl>
|
|
54367
55037
|
<dd>
|
|
54368
55038
|
|
|
54369
|
-
**
|
|
55039
|
+
**details:** `String`
|
|
54370
55040
|
|
|
54371
55041
|
</dd>
|
|
54372
55042
|
</dl>
|
|
@@ -54374,7 +55044,15 @@ client.consolidation.report(
|
|
|
54374
55044
|
<dl>
|
|
54375
55045
|
<dd>
|
|
54376
55046
|
|
|
54377
|
-
**
|
|
55047
|
+
**website:** `String`
|
|
55048
|
+
|
|
55049
|
+
</dd>
|
|
55050
|
+
</dl>
|
|
55051
|
+
|
|
55052
|
+
<dl>
|
|
55053
|
+
<dd>
|
|
55054
|
+
|
|
55055
|
+
**request_options:** `Nordlet::Public::RequestOptions`
|
|
54378
55056
|
|
|
54379
55057
|
</dd>
|
|
54380
55058
|
</dl>
|
|
@@ -54386,8 +55064,7 @@ client.consolidation.report(
|
|
|
54386
55064
|
</dl>
|
|
54387
55065
|
</details>
|
|
54388
55066
|
|
|
54389
|
-
|
|
54390
|
-
<details><summary><code>client.public.<a href="/lib/nordlet/public/client.rb">integration_requests</a>(request) -> Nordlet::Public::Types::IntegrationRequestsPublicResponse</code></summary>
|
|
55067
|
+
<details><summary><code>client.public.<a href="/lib/nordlet/public/client.rb">pay</a>(token:) -> </code></summary>
|
|
54391
55068
|
<dl>
|
|
54392
55069
|
<dd>
|
|
54393
55070
|
|
|
@@ -54399,7 +55076,7 @@ client.consolidation.report(
|
|
|
54399
55076
|
<dl>
|
|
54400
55077
|
<dd>
|
|
54401
55078
|
|
|
54402
|
-
|
|
55079
|
+
Redirect (302) to the company's payment page for the issued invoice that carries this payment token, rendered from the template set with `sales/invoices/payment-settings/update` with the invoice number, the amount still unpaid, the currency, the token, the invoice id and the customer name (see `sales/invoices/payment-link`). Answers 404 when the token matches no issued invoice, the invoice has `payLinkEnabled` false or the company has no template, and 409 when the invoice is already paid.
|
|
54403
55080
|
</dd>
|
|
54404
55081
|
</dl>
|
|
54405
55082
|
</dd>
|
|
@@ -54414,11 +55091,7 @@ Store a request for an integration: the integration asked for and the sender's n
|
|
|
54414
55091
|
<dd>
|
|
54415
55092
|
|
|
54416
55093
|
```ruby
|
|
54417
|
-
client.public.
|
|
54418
|
-
integration: "integration",
|
|
54419
|
-
name: "name",
|
|
54420
|
-
email: "email"
|
|
54421
|
-
)
|
|
55094
|
+
client.public.pay(token: "token")
|
|
54422
55095
|
```
|
|
54423
55096
|
</dd>
|
|
54424
55097
|
</dl>
|
|
@@ -54433,7 +55106,7 @@ client.public.integration_requests(
|
|
|
54433
55106
|
<dl>
|
|
54434
55107
|
<dd>
|
|
54435
55108
|
|
|
54436
|
-
**
|
|
55109
|
+
**token:** `String`
|
|
54437
55110
|
|
|
54438
55111
|
</dd>
|
|
54439
55112
|
</dl>
|
|
@@ -54441,23 +55114,61 @@ client.public.integration_requests(
|
|
|
54441
55114
|
<dl>
|
|
54442
55115
|
<dd>
|
|
54443
55116
|
|
|
54444
|
-
**
|
|
55117
|
+
**request_options:** `Nordlet::Public::RequestOptions`
|
|
54445
55118
|
|
|
54446
55119
|
</dd>
|
|
54447
55120
|
</dl>
|
|
55121
|
+
</dd>
|
|
55122
|
+
</dl>
|
|
55123
|
+
|
|
54448
55124
|
|
|
55125
|
+
</dd>
|
|
55126
|
+
</dl>
|
|
55127
|
+
</details>
|
|
55128
|
+
|
|
55129
|
+
<details><summary><code>client.public.<a href="/lib/nordlet/public/client.rb">invoices_get</a>(request) -> Nordlet::Public::Types::InvoicesGetPublicResponse</code></summary>
|
|
54449
55130
|
<dl>
|
|
54450
55131
|
<dd>
|
|
54451
55132
|
|
|
54452
|
-
|
|
54453
|
-
|
|
55133
|
+
#### 📝 Description
|
|
55134
|
+
|
|
55135
|
+
<dl>
|
|
55136
|
+
<dd>
|
|
55137
|
+
|
|
55138
|
+
<dl>
|
|
55139
|
+
<dd>
|
|
55140
|
+
|
|
55141
|
+
Return the issued sale document that carries this customer token (`token` of `sales/invoices/view`), in the shape of `sales/invoices/view` without the token. Answers 404 when the token matches no issued document.
|
|
54454
55142
|
</dd>
|
|
54455
55143
|
</dl>
|
|
55144
|
+
</dd>
|
|
55145
|
+
</dl>
|
|
55146
|
+
|
|
55147
|
+
#### 🔌 Usage
|
|
54456
55148
|
|
|
54457
55149
|
<dl>
|
|
54458
55150
|
<dd>
|
|
54459
55151
|
|
|
54460
|
-
|
|
55152
|
+
<dl>
|
|
55153
|
+
<dd>
|
|
55154
|
+
|
|
55155
|
+
```ruby
|
|
55156
|
+
client.public.invoices_get(token: "token")
|
|
55157
|
+
```
|
|
55158
|
+
</dd>
|
|
55159
|
+
</dl>
|
|
55160
|
+
</dd>
|
|
55161
|
+
</dl>
|
|
55162
|
+
|
|
55163
|
+
#### ⚙️ Parameters
|
|
55164
|
+
|
|
55165
|
+
<dl>
|
|
55166
|
+
<dd>
|
|
55167
|
+
|
|
55168
|
+
<dl>
|
|
55169
|
+
<dd>
|
|
55170
|
+
|
|
55171
|
+
**token:** `String`
|
|
54461
55172
|
|
|
54462
55173
|
</dd>
|
|
54463
55174
|
</dl>
|
|
@@ -54465,15 +55176,61 @@ client.public.integration_requests(
|
|
|
54465
55176
|
<dl>
|
|
54466
55177
|
<dd>
|
|
54467
55178
|
|
|
54468
|
-
**
|
|
55179
|
+
**request_options:** `Nordlet::Public::RequestOptions`
|
|
54469
55180
|
|
|
54470
55181
|
</dd>
|
|
54471
55182
|
</dl>
|
|
55183
|
+
</dd>
|
|
55184
|
+
</dl>
|
|
54472
55185
|
|
|
55186
|
+
|
|
55187
|
+
</dd>
|
|
55188
|
+
</dl>
|
|
55189
|
+
</details>
|
|
55190
|
+
|
|
55191
|
+
<details><summary><code>client.public.<a href="/lib/nordlet/public/client.rb">invoices_checkout</a>(request) -> Nordlet::Public::Types::InvoicesCheckoutPublicResponse</code></summary>
|
|
54473
55192
|
<dl>
|
|
54474
55193
|
<dd>
|
|
54475
55194
|
|
|
54476
|
-
|
|
55195
|
+
#### 📝 Description
|
|
55196
|
+
|
|
55197
|
+
<dl>
|
|
55198
|
+
<dd>
|
|
55199
|
+
|
|
55200
|
+
<dl>
|
|
55201
|
+
<dd>
|
|
55202
|
+
|
|
55203
|
+
Open a Stripe Checkout page on the company's connected Stripe account for the amount still unpaid on the issued invoice that carries this customer token, and return its `url`. Stripe sends the customer back to the public invoice page. Answers 404 when the token matches no issued invoice, the invoice has `payLinkEnabled` false or the company has no Stripe account that can take charges, 409 when the invoice is already paid and 422 when Stripe cannot take the amount in the invoice currency.
|
|
55204
|
+
</dd>
|
|
55205
|
+
</dl>
|
|
55206
|
+
</dd>
|
|
55207
|
+
</dl>
|
|
55208
|
+
|
|
55209
|
+
#### 🔌 Usage
|
|
55210
|
+
|
|
55211
|
+
<dl>
|
|
55212
|
+
<dd>
|
|
55213
|
+
|
|
55214
|
+
<dl>
|
|
55215
|
+
<dd>
|
|
55216
|
+
|
|
55217
|
+
```ruby
|
|
55218
|
+
client.public.invoices_checkout(token: "token")
|
|
55219
|
+
```
|
|
55220
|
+
</dd>
|
|
55221
|
+
</dl>
|
|
55222
|
+
</dd>
|
|
55223
|
+
</dl>
|
|
55224
|
+
|
|
55225
|
+
#### ⚙️ Parameters
|
|
55226
|
+
|
|
55227
|
+
<dl>
|
|
55228
|
+
<dd>
|
|
55229
|
+
|
|
55230
|
+
<dl>
|
|
55231
|
+
<dd>
|
|
55232
|
+
|
|
55233
|
+
**token:** `String`
|
|
54477
55234
|
|
|
54478
55235
|
</dd>
|
|
54479
55236
|
</dl>
|
|
@@ -54493,7 +55250,7 @@ client.public.integration_requests(
|
|
|
54493
55250
|
</dl>
|
|
54494
55251
|
</details>
|
|
54495
55252
|
|
|
54496
|
-
<details><summary><code>client.public.<a href="/lib/nordlet/public/client.rb">
|
|
55253
|
+
<details><summary><code>client.public.<a href="/lib/nordlet/public/client.rb">invoices_pdf</a>(request) -> Nordlet::Public::Types::InvoicesPdfPublicResponse</code></summary>
|
|
54497
55254
|
<dl>
|
|
54498
55255
|
<dd>
|
|
54499
55256
|
|
|
@@ -54505,7 +55262,7 @@ client.public.integration_requests(
|
|
|
54505
55262
|
<dl>
|
|
54506
55263
|
<dd>
|
|
54507
55264
|
|
|
54508
|
-
|
|
55265
|
+
Return the PDF of the issued sale document that carries this customer token, base64-encoded, as `sales/invoices/pdf` renders it in the document's own language, English when it has none. Answers 404 when the token matches no issued document.
|
|
54509
55266
|
</dd>
|
|
54510
55267
|
</dl>
|
|
54511
55268
|
</dd>
|
|
@@ -54520,7 +55277,7 @@ Redirect (302) to the company's payment page for the issued invoice that carries
|
|
|
54520
55277
|
<dd>
|
|
54521
55278
|
|
|
54522
55279
|
```ruby
|
|
54523
|
-
client.public.
|
|
55280
|
+
client.public.invoices_pdf(token: "token")
|
|
54524
55281
|
```
|
|
54525
55282
|
</dd>
|
|
54526
55283
|
</dl>
|
|
@@ -55021,7 +55778,7 @@ client.billing.topup_confirm(session_id: "sessionId")
|
|
|
55021
55778
|
<dl>
|
|
55022
55779
|
<dd>
|
|
55023
55780
|
|
|
55024
|
-
Open a Stripe Checkout session for a flat-rate subscription on `plan`, with the trial period of `trialDays` days, and return its URL; a Stripe customer is created for the user when there is none. Answers 409 when a flat-rate subscription is already active and 503 when online payments are not configured
|
|
55781
|
+
Open a Stripe Checkout session for a flat-rate subscription on `plan`, with the trial period of `trialDays` days, and return its URL; a Stripe customer is created for the user when there is none. The `invoicing` plan of the invoice tool takes its trial days from the server setting `INVOICE_PLAN_TRIAL_DAYS` and returns to the invoice app. Answers 409 when a flat-rate subscription is already active and 503 when online payments are not configured, the plan has no price, or the Invoicing trial is not set.
|
|
55025
55782
|
</dd>
|
|
55026
55783
|
</dl>
|
|
55027
55784
|
</dd>
|
|
@@ -55137,6 +55894,60 @@ client.billing.flat_rate_confirm(session_id: "sessionId")
|
|
|
55137
55894
|
</dl>
|
|
55138
55895
|
|
|
55139
55896
|
|
|
55897
|
+
</dd>
|
|
55898
|
+
</dl>
|
|
55899
|
+
</details>
|
|
55900
|
+
|
|
55901
|
+
<details><summary><code>client.billing.<a href="/lib/nordlet/billing/client.rb">subscription_cancel</a>(request) -> Nordlet::Billing::Types::SubscriptionCancelBillingResponse</code></summary>
|
|
55902
|
+
<dl>
|
|
55903
|
+
<dd>
|
|
55904
|
+
|
|
55905
|
+
#### 📝 Description
|
|
55906
|
+
|
|
55907
|
+
<dl>
|
|
55908
|
+
<dd>
|
|
55909
|
+
|
|
55910
|
+
<dl>
|
|
55911
|
+
<dd>
|
|
55912
|
+
|
|
55913
|
+
Cancel the user's Stripe subscription at the end of the period already paid: the plan stays active until `subscriptionCancelAt`, and Stripe then ends the subscription, which its `customer.subscription.deleted` webhook records. Answers 503 when online payments are not configured and 409 when the account has no subscription.
|
|
55914
|
+
</dd>
|
|
55915
|
+
</dl>
|
|
55916
|
+
</dd>
|
|
55917
|
+
</dl>
|
|
55918
|
+
|
|
55919
|
+
#### 🔌 Usage
|
|
55920
|
+
|
|
55921
|
+
<dl>
|
|
55922
|
+
<dd>
|
|
55923
|
+
|
|
55924
|
+
<dl>
|
|
55925
|
+
<dd>
|
|
55926
|
+
|
|
55927
|
+
```ruby
|
|
55928
|
+
client.billing.subscription_cancel
|
|
55929
|
+
```
|
|
55930
|
+
</dd>
|
|
55931
|
+
</dl>
|
|
55932
|
+
</dd>
|
|
55933
|
+
</dl>
|
|
55934
|
+
|
|
55935
|
+
#### ⚙️ Parameters
|
|
55936
|
+
|
|
55937
|
+
<dl>
|
|
55938
|
+
<dd>
|
|
55939
|
+
|
|
55940
|
+
<dl>
|
|
55941
|
+
<dd>
|
|
55942
|
+
|
|
55943
|
+
**request_options:** `Nordlet::Billing::RequestOptions`
|
|
55944
|
+
|
|
55945
|
+
</dd>
|
|
55946
|
+
</dl>
|
|
55947
|
+
</dd>
|
|
55948
|
+
</dl>
|
|
55949
|
+
|
|
55950
|
+
|
|
55140
55951
|
</dd>
|
|
55141
55952
|
</dl>
|
|
55142
55953
|
</details>
|
|
@@ -56439,6 +57250,62 @@ client.account.companies_create(name: "name")
|
|
|
56439
57250
|
<dl>
|
|
56440
57251
|
<dd>
|
|
56441
57252
|
|
|
57253
|
+
**bank_bic:** `String`
|
|
57254
|
+
|
|
57255
|
+
</dd>
|
|
57256
|
+
</dl>
|
|
57257
|
+
|
|
57258
|
+
<dl>
|
|
57259
|
+
<dd>
|
|
57260
|
+
|
|
57261
|
+
**bank_code:** `String` — Sort code, routing number, BSB, IFSC or institution number
|
|
57262
|
+
|
|
57263
|
+
</dd>
|
|
57264
|
+
</dl>
|
|
57265
|
+
|
|
57266
|
+
<dl>
|
|
57267
|
+
<dd>
|
|
57268
|
+
|
|
57269
|
+
**bank_branch_code:** `String` — Transit number (Canada)
|
|
57270
|
+
|
|
57271
|
+
</dd>
|
|
57272
|
+
</dl>
|
|
57273
|
+
|
|
57274
|
+
<dl>
|
|
57275
|
+
<dd>
|
|
57276
|
+
|
|
57277
|
+
**bank_account_number:** `String`
|
|
57278
|
+
|
|
57279
|
+
</dd>
|
|
57280
|
+
</dl>
|
|
57281
|
+
|
|
57282
|
+
<dl>
|
|
57283
|
+
<dd>
|
|
57284
|
+
|
|
57285
|
+
**invoice_prefix:** `String` — Prefix of the numbers of invoices issued without a document series; SF when not set
|
|
57286
|
+
|
|
57287
|
+
</dd>
|
|
57288
|
+
</dl>
|
|
57289
|
+
|
|
57290
|
+
<dl>
|
|
57291
|
+
<dd>
|
|
57292
|
+
|
|
57293
|
+
**default_invoice_locale:** `Nordlet::Account::Types::CompaniesCreateAccountRequestDefaultInvoiceLocale` — Language a new invoice starts with when neither the invoice nor its partner names one
|
|
57294
|
+
|
|
57295
|
+
</dd>
|
|
57296
|
+
</dl>
|
|
57297
|
+
|
|
57298
|
+
<dl>
|
|
57299
|
+
<dd>
|
|
57300
|
+
|
|
57301
|
+
**default_invoice_note:** `String` — Note a new invoice, proforma or advance invoice starts with when it names no notes
|
|
57302
|
+
|
|
57303
|
+
</dd>
|
|
57304
|
+
</dl>
|
|
57305
|
+
|
|
57306
|
+
<dl>
|
|
57307
|
+
<dd>
|
|
57308
|
+
|
|
56442
57309
|
**peppol_id:** `String`
|
|
56443
57310
|
|
|
56444
57311
|
</dd>
|
|
@@ -56559,6 +57426,14 @@ client.account.companies_create(name: "name")
|
|
|
56559
57426
|
<dl>
|
|
56560
57427
|
<dd>
|
|
56561
57428
|
|
|
57429
|
+
**cash_basis:** `Internal::Types::Boolean` — The company determines its profit on a cash basis (receipts and payments, in Germany the Einnahmenüberschussrechnung of § 4 Abs. 3 EStG); it gets the cash-basis returns in its filing calendar (immutable after creation)
|
|
57430
|
+
|
|
57431
|
+
</dd>
|
|
57432
|
+
</dl>
|
|
57433
|
+
|
|
57434
|
+
<dl>
|
|
57435
|
+
<dd>
|
|
57436
|
+
|
|
56562
57437
|
**request_options:** `Nordlet::Account::RequestOptions`
|
|
56563
57438
|
|
|
56564
57439
|
</dd>
|
|
@@ -56699,7 +57574,7 @@ client.account.companies_profile
|
|
|
56699
57574
|
<dl>
|
|
56700
57575
|
<dd>
|
|
56701
57576
|
|
|
56702
|
-
Change the profile of the active company; owners and admins may call it. Only the fields sent are changed, and the nullable ones can be sent as null to clear them. `logo` stores a base64-encoded image as a file of the company and sets `logoFileId`. The country, base currency and
|
|
57577
|
+
Change the profile of the active company; owners and admins may call it. Only the fields sent are changed, and the nullable ones can be sent as null to clear them. `logo` stores a base64-encoded image as a file of the company and sets `logoFileId`. The country, base currency, sandbox flag and cash-basis flag are fixed at creation.
|
|
56703
57578
|
</dd>
|
|
56704
57579
|
</dl>
|
|
56705
57580
|
</dd>
|
|
@@ -56841,6 +57716,62 @@ client.account.companies_update
|
|
|
56841
57716
|
<dl>
|
|
56842
57717
|
<dd>
|
|
56843
57718
|
|
|
57719
|
+
**bank_bic:** `String`
|
|
57720
|
+
|
|
57721
|
+
</dd>
|
|
57722
|
+
</dl>
|
|
57723
|
+
|
|
57724
|
+
<dl>
|
|
57725
|
+
<dd>
|
|
57726
|
+
|
|
57727
|
+
**bank_code:** `String` — Sort code, routing number, BSB, IFSC or institution number
|
|
57728
|
+
|
|
57729
|
+
</dd>
|
|
57730
|
+
</dl>
|
|
57731
|
+
|
|
57732
|
+
<dl>
|
|
57733
|
+
<dd>
|
|
57734
|
+
|
|
57735
|
+
**bank_branch_code:** `String` — Transit number (Canada)
|
|
57736
|
+
|
|
57737
|
+
</dd>
|
|
57738
|
+
</dl>
|
|
57739
|
+
|
|
57740
|
+
<dl>
|
|
57741
|
+
<dd>
|
|
57742
|
+
|
|
57743
|
+
**bank_account_number:** `String`
|
|
57744
|
+
|
|
57745
|
+
</dd>
|
|
57746
|
+
</dl>
|
|
57747
|
+
|
|
57748
|
+
<dl>
|
|
57749
|
+
<dd>
|
|
57750
|
+
|
|
57751
|
+
**invoice_prefix:** `String` — Prefix of the numbers of invoices issued without a document series; SF when not set
|
|
57752
|
+
|
|
57753
|
+
</dd>
|
|
57754
|
+
</dl>
|
|
57755
|
+
|
|
57756
|
+
<dl>
|
|
57757
|
+
<dd>
|
|
57758
|
+
|
|
57759
|
+
**default_invoice_locale:** `Nordlet::Account::Types::CompaniesUpdateAccountRequestDefaultInvoiceLocale` — Language a new invoice starts with when neither the invoice nor its partner names one
|
|
57760
|
+
|
|
57761
|
+
</dd>
|
|
57762
|
+
</dl>
|
|
57763
|
+
|
|
57764
|
+
<dl>
|
|
57765
|
+
<dd>
|
|
57766
|
+
|
|
57767
|
+
**default_invoice_note:** `String` — Note a new invoice, proforma or advance invoice starts with when it names no notes
|
|
57768
|
+
|
|
57769
|
+
</dd>
|
|
57770
|
+
</dl>
|
|
57771
|
+
|
|
57772
|
+
<dl>
|
|
57773
|
+
<dd>
|
|
57774
|
+
|
|
56844
57775
|
**peppol_id:** `String`
|
|
56845
57776
|
|
|
56846
57777
|
</dd>
|