nordlet 0.5.5 → 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 +5 -4
- 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/login_link_request_account_request.rb +2 -0
- data/lib/nordlet/account/types/login_link_request_account_request_app.rb +13 -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 +121 -7
- 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/debt_reminders_list_partners_response_rows_item.rb +2 -0
- data/lib/nordlet/partners/types/debt_reminders_list_partners_response_rows_item_kind.rb +14 -0
- data/lib/nordlet/partners/types/debt_reminders_settings_get_partners_request.rb +9 -0
- data/lib/nordlet/partners/types/debt_reminders_settings_get_partners_response.rb +13 -0
- data/lib/nordlet/partners/types/debt_reminders_settings_update_partners_request.rb +13 -0
- data/lib/nordlet/partners/types/debt_reminders_settings_update_partners_response.rb +13 -0
- data/lib/nordlet/partners/types/debt_reminders_upcoming_partners_request.rb +9 -0
- data/lib/nordlet/partners/types/debt_reminders_upcoming_partners_response.rb +11 -0
- data/lib/nordlet/partners/types/debt_reminders_upcoming_partners_response_rows_item.rb +27 -0
- data/lib/nordlet/partners/types/debt_reminders_upcoming_partners_response_rows_item_kind.rb +14 -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 +71 -0
- data/reference.md +2012 -895
- metadata +73 -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 selection of the daily debt-reminder job for this company as of the company's current date and returns
|
|
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>
|
|
@@ -3255,7 +3255,7 @@ client.partners.debt_reminders_preview
|
|
|
3255
3255
|
<dl>
|
|
3256
3256
|
<dd>
|
|
3257
3257
|
|
|
3258
|
-
Lists the debt reminders the daily job has sent, one row per partner and currency with the ids of the invoices it covered; filterable by `partnerId`, sortable by `sentAt`.
|
|
3258
|
+
Lists the debt reminders the daily job has sent, one row per partner and currency with the ids of the invoices it covered and its `kind` (`before_due` or `overdue`); filterable by `partnerId`, sortable by `sentAt`.
|
|
3259
3259
|
</dd>
|
|
3260
3260
|
</dl>
|
|
3261
3261
|
</dd>
|
|
@@ -3337,7 +3337,7 @@ client.partners.debt_reminders_list
|
|
|
3337
3337
|
</dl>
|
|
3338
3338
|
</details>
|
|
3339
3339
|
|
|
3340
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
3340
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">debt_reminders_settings_get</a>(request) -> Nordlet::Partners::Types::DebtRemindersSettingsGetPartnersResponse</code></summary>
|
|
3341
3341
|
<dl>
|
|
3342
3342
|
<dd>
|
|
3343
3343
|
|
|
@@ -3349,7 +3349,7 @@ client.partners.debt_reminders_list
|
|
|
3349
3349
|
<dl>
|
|
3350
3350
|
<dd>
|
|
3351
3351
|
|
|
3352
|
-
|
|
3352
|
+
Returns the debt-reminder schedule of the company: `daysBefore`, the days before the due date on which the first reminder is sent (null when no reminder is sent before the due date), and `repeatDays`, the days between overdue reminders to a partner.
|
|
3353
3353
|
</dd>
|
|
3354
3354
|
</dl>
|
|
3355
3355
|
</dd>
|
|
@@ -3364,7 +3364,7 @@ Checks a VAT number against VIES, either a free `vatCode` or the VAT code of the
|
|
|
3364
3364
|
<dd>
|
|
3365
3365
|
|
|
3366
3366
|
```ruby
|
|
3367
|
-
client.partners.
|
|
3367
|
+
client.partners.debt_reminders_settings_get
|
|
3368
3368
|
```
|
|
3369
3369
|
</dd>
|
|
3370
3370
|
</dl>
|
|
@@ -3379,22 +3379,6 @@ client.partners.validate_vat
|
|
|
3379
3379
|
<dl>
|
|
3380
3380
|
<dd>
|
|
3381
3381
|
|
|
3382
|
-
**vat_code:** `String`
|
|
3383
|
-
|
|
3384
|
-
</dd>
|
|
3385
|
-
</dl>
|
|
3386
|
-
|
|
3387
|
-
<dl>
|
|
3388
|
-
<dd>
|
|
3389
|
-
|
|
3390
|
-
**partner_id:** `String`
|
|
3391
|
-
|
|
3392
|
-
</dd>
|
|
3393
|
-
</dl>
|
|
3394
|
-
|
|
3395
|
-
<dl>
|
|
3396
|
-
<dd>
|
|
3397
|
-
|
|
3398
3382
|
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
3399
3383
|
|
|
3400
3384
|
</dd>
|
|
@@ -3407,7 +3391,7 @@ client.partners.validate_vat
|
|
|
3407
3391
|
</dl>
|
|
3408
3392
|
</details>
|
|
3409
3393
|
|
|
3410
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
3394
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">debt_reminders_settings_update</a>(request) -> Nordlet::Partners::Types::DebtRemindersSettingsUpdatePartnersResponse</code></summary>
|
|
3411
3395
|
<dl>
|
|
3412
3396
|
<dd>
|
|
3413
3397
|
|
|
@@ -3419,7 +3403,7 @@ client.partners.validate_vat
|
|
|
3419
3403
|
<dl>
|
|
3420
3404
|
<dd>
|
|
3421
3405
|
|
|
3422
|
-
|
|
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.
|
|
3423
3407
|
</dd>
|
|
3424
3408
|
</dl>
|
|
3425
3409
|
</dd>
|
|
@@ -3434,7 +3418,7 @@ Lists the VAT reviews opened by VIES checks of partners' VAT codes, with reason
|
|
|
3434
3418
|
<dd>
|
|
3435
3419
|
|
|
3436
3420
|
```ruby
|
|
3437
|
-
client.partners.
|
|
3421
|
+
client.partners.debt_reminders_settings_update
|
|
3438
3422
|
```
|
|
3439
3423
|
</dd>
|
|
3440
3424
|
</dl>
|
|
@@ -3449,15 +3433,7 @@ client.partners.vat_reviews_list
|
|
|
3449
3433
|
<dl>
|
|
3450
3434
|
<dd>
|
|
3451
3435
|
|
|
3452
|
-
**
|
|
3453
|
-
|
|
3454
|
-
</dd>
|
|
3455
|
-
</dl>
|
|
3456
|
-
|
|
3457
|
-
<dl>
|
|
3458
|
-
<dd>
|
|
3459
|
-
|
|
3460
|
-
**page_size:** `Integer`
|
|
3436
|
+
**days_before:** `Integer`
|
|
3461
3437
|
|
|
3462
3438
|
</dd>
|
|
3463
3439
|
</dl>
|
|
@@ -3465,23 +3441,7 @@ client.partners.vat_reviews_list
|
|
|
3465
3441
|
<dl>
|
|
3466
3442
|
<dd>
|
|
3467
3443
|
|
|
3468
|
-
**
|
|
3469
|
-
|
|
3470
|
-
</dd>
|
|
3471
|
-
</dl>
|
|
3472
|
-
|
|
3473
|
-
<dl>
|
|
3474
|
-
<dd>
|
|
3475
|
-
|
|
3476
|
-
**filter:** `Internal::Types::Array[Nordlet::Partners::Types::VatReviewsListPartnersRequestFilterItem]`
|
|
3477
|
-
|
|
3478
|
-
</dd>
|
|
3479
|
-
</dl>
|
|
3480
|
-
|
|
3481
|
-
<dl>
|
|
3482
|
-
<dd>
|
|
3483
|
-
|
|
3484
|
-
**totals:** `Internal::Types::Array[String]` — Numeric fields to sum over every row matching the filter (not only the current page)
|
|
3444
|
+
**repeat_days:** `Integer`
|
|
3485
3445
|
|
|
3486
3446
|
</dd>
|
|
3487
3447
|
</dl>
|
|
@@ -3501,7 +3461,7 @@ client.partners.vat_reviews_list
|
|
|
3501
3461
|
</dl>
|
|
3502
3462
|
</details>
|
|
3503
3463
|
|
|
3504
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
3464
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">debt_reminders_upcoming</a>(request) -> Nordlet::Partners::Types::DebtRemindersUpcomingPartnersResponse</code></summary>
|
|
3505
3465
|
<dl>
|
|
3506
3466
|
<dd>
|
|
3507
3467
|
|
|
@@ -3513,7 +3473,7 @@ client.partners.vat_reviews_list
|
|
|
3513
3473
|
<dl>
|
|
3514
3474
|
<dd>
|
|
3515
3475
|
|
|
3516
|
-
|
|
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.
|
|
3517
3477
|
</dd>
|
|
3518
3478
|
</dl>
|
|
3519
3479
|
</dd>
|
|
@@ -3528,10 +3488,7 @@ Closes an open VAT review as `confirmed_valid`, `confirmed_invalid` or `dismisse
|
|
|
3528
3488
|
<dd>
|
|
3529
3489
|
|
|
3530
3490
|
```ruby
|
|
3531
|
-
client.partners.
|
|
3532
|
-
id: "id",
|
|
3533
|
-
resolution: "confirmed_valid"
|
|
3534
|
-
)
|
|
3491
|
+
client.partners.debt_reminders_upcoming
|
|
3535
3492
|
```
|
|
3536
3493
|
</dd>
|
|
3537
3494
|
</dl>
|
|
@@ -3546,30 +3503,6 @@ client.partners.vat_reviews_resolve(
|
|
|
3546
3503
|
<dl>
|
|
3547
3504
|
<dd>
|
|
3548
3505
|
|
|
3549
|
-
**id:** `String`
|
|
3550
|
-
|
|
3551
|
-
</dd>
|
|
3552
|
-
</dl>
|
|
3553
|
-
|
|
3554
|
-
<dl>
|
|
3555
|
-
<dd>
|
|
3556
|
-
|
|
3557
|
-
**resolution:** `Nordlet::Partners::Types::VatReviewsResolvePartnersRequestResolution`
|
|
3558
|
-
|
|
3559
|
-
</dd>
|
|
3560
|
-
</dl>
|
|
3561
|
-
|
|
3562
|
-
<dl>
|
|
3563
|
-
<dd>
|
|
3564
|
-
|
|
3565
|
-
**note:** `String`
|
|
3566
|
-
|
|
3567
|
-
</dd>
|
|
3568
|
-
</dl>
|
|
3569
|
-
|
|
3570
|
-
<dl>
|
|
3571
|
-
<dd>
|
|
3572
|
-
|
|
3573
3506
|
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
3574
3507
|
|
|
3575
3508
|
</dd>
|
|
@@ -3582,7 +3515,7 @@ client.partners.vat_reviews_resolve(
|
|
|
3582
3515
|
</dl>
|
|
3583
3516
|
</details>
|
|
3584
3517
|
|
|
3585
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
3518
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">validate_vat</a>(request) -> Nordlet::Partners::Types::ValidateVatPartnersResponse</code></summary>
|
|
3586
3519
|
<dl>
|
|
3587
3520
|
<dd>
|
|
3588
3521
|
|
|
@@ -3594,7 +3527,7 @@ client.partners.vat_reviews_resolve(
|
|
|
3594
3527
|
<dl>
|
|
3595
3528
|
<dd>
|
|
3596
3529
|
|
|
3597
|
-
|
|
3530
|
+
Checks a VAT number against VIES, either a free `vatCode` or the VAT code of the partner in `partnerId` (exactly one of the two); a code without an EU country prefix and 2 to 12 alphanumeric characters is refused with 422, as is a partner without a VAT code, and a VIES outage answers 503. With a partner the outcome is written to it (`vatValid`, `vatValidatedAt`): an invalid number or a VIES name that shares no word with the partner's name opens or refreshes the partner's VAT review (`vat_review.opened`), a VIES failure opens one with reason `service_error`, and a valid matching number resolves the open review as `revalidated` (`vat_review.resolved`). Reviews are listed and closed with `partners/vat-reviews/list` and `partners/vat-reviews/resolve`.
|
|
3598
3531
|
</dd>
|
|
3599
3532
|
</dl>
|
|
3600
3533
|
</dd>
|
|
@@ -3609,7 +3542,7 @@ Creates a partner. `groupId`, `statusId` and `priceListId` must belong to the co
|
|
|
3609
3542
|
<dd>
|
|
3610
3543
|
|
|
3611
3544
|
```ruby
|
|
3612
|
-
client.partners.
|
|
3545
|
+
client.partners.validate_vat
|
|
3613
3546
|
```
|
|
3614
3547
|
</dd>
|
|
3615
3548
|
</dl>
|
|
@@ -3624,7 +3557,7 @@ client.partners.create(name: "name")
|
|
|
3624
3557
|
<dl>
|
|
3625
3558
|
<dd>
|
|
3626
3559
|
|
|
3627
|
-
**
|
|
3560
|
+
**vat_code:** `String`
|
|
3628
3561
|
|
|
3629
3562
|
</dd>
|
|
3630
3563
|
</dl>
|
|
@@ -3632,7 +3565,7 @@ client.partners.create(name: "name")
|
|
|
3632
3565
|
<dl>
|
|
3633
3566
|
<dd>
|
|
3634
3567
|
|
|
3635
|
-
**
|
|
3568
|
+
**partner_id:** `String`
|
|
3636
3569
|
|
|
3637
3570
|
</dd>
|
|
3638
3571
|
</dl>
|
|
@@ -3640,111 +3573,61 @@ client.partners.create(name: "name")
|
|
|
3640
3573
|
<dl>
|
|
3641
3574
|
<dd>
|
|
3642
3575
|
|
|
3643
|
-
**
|
|
3576
|
+
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
3644
3577
|
|
|
3645
3578
|
</dd>
|
|
3646
3579
|
</dl>
|
|
3647
|
-
|
|
3648
|
-
<dl>
|
|
3649
|
-
<dd>
|
|
3650
|
-
|
|
3651
|
-
**vat_code:** `String`
|
|
3652
|
-
|
|
3653
3580
|
</dd>
|
|
3654
3581
|
</dl>
|
|
3655
3582
|
|
|
3656
|
-
<dl>
|
|
3657
|
-
<dd>
|
|
3658
3583
|
|
|
3659
|
-
**peppol_id:** `String`
|
|
3660
|
-
|
|
3661
3584
|
</dd>
|
|
3662
3585
|
</dl>
|
|
3586
|
+
</details>
|
|
3663
3587
|
|
|
3588
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">vat_reviews_list</a>(request) -> Nordlet::Partners::Types::VatReviewsListPartnersResponse</code></summary>
|
|
3664
3589
|
<dl>
|
|
3665
3590
|
<dd>
|
|
3666
3591
|
|
|
3667
|
-
|
|
3668
|
-
|
|
3669
|
-
</dd>
|
|
3670
|
-
</dl>
|
|
3592
|
+
#### 📝 Description
|
|
3671
3593
|
|
|
3672
3594
|
<dl>
|
|
3673
3595
|
<dd>
|
|
3674
3596
|
|
|
3675
|
-
**phone:** `String`
|
|
3676
|
-
|
|
3677
|
-
</dd>
|
|
3678
|
-
</dl>
|
|
3679
|
-
|
|
3680
3597
|
<dl>
|
|
3681
3598
|
<dd>
|
|
3682
3599
|
|
|
3683
|
-
|
|
3684
|
-
|
|
3600
|
+
Lists the VAT reviews opened by VIES checks of partners' VAT codes, with reason `invalid`, `name_mismatch` or `service_error`; filterable by `partnerId`, `status` and `reason`, sortable by `createdAt`.
|
|
3685
3601
|
</dd>
|
|
3686
3602
|
</dl>
|
|
3687
|
-
|
|
3688
|
-
<dl>
|
|
3689
|
-
<dd>
|
|
3690
|
-
|
|
3691
|
-
**birth_date:** `String`
|
|
3692
|
-
|
|
3693
3603
|
</dd>
|
|
3694
3604
|
</dl>
|
|
3695
3605
|
|
|
3696
|
-
|
|
3697
|
-
<dd>
|
|
3698
|
-
|
|
3699
|
-
**is_customer:** `Internal::Types::Boolean`
|
|
3700
|
-
|
|
3701
|
-
</dd>
|
|
3702
|
-
</dl>
|
|
3606
|
+
#### 🔌 Usage
|
|
3703
3607
|
|
|
3704
3608
|
<dl>
|
|
3705
3609
|
<dd>
|
|
3706
3610
|
|
|
3707
|
-
**is_supplier:** `Internal::Types::Boolean`
|
|
3708
|
-
|
|
3709
|
-
</dd>
|
|
3710
|
-
</dl>
|
|
3711
|
-
|
|
3712
3611
|
<dl>
|
|
3713
3612
|
<dd>
|
|
3714
3613
|
|
|
3715
|
-
|
|
3716
|
-
|
|
3614
|
+
```ruby
|
|
3615
|
+
client.partners.vat_reviews_list
|
|
3616
|
+
```
|
|
3717
3617
|
</dd>
|
|
3718
3618
|
</dl>
|
|
3719
|
-
|
|
3720
|
-
<dl>
|
|
3721
|
-
<dd>
|
|
3722
|
-
|
|
3723
|
-
**credit_limit:** `String`
|
|
3724
|
-
|
|
3725
3619
|
</dd>
|
|
3726
3620
|
</dl>
|
|
3727
3621
|
|
|
3728
|
-
|
|
3729
|
-
<dd>
|
|
3730
|
-
|
|
3731
|
-
**price_list_id:** `String`
|
|
3732
|
-
|
|
3733
|
-
</dd>
|
|
3734
|
-
</dl>
|
|
3622
|
+
#### ⚙️ Parameters
|
|
3735
3623
|
|
|
3736
3624
|
<dl>
|
|
3737
3625
|
<dd>
|
|
3738
3626
|
|
|
3739
|
-
**group_id:** `String`
|
|
3740
|
-
|
|
3741
|
-
</dd>
|
|
3742
|
-
</dl>
|
|
3743
|
-
|
|
3744
3627
|
<dl>
|
|
3745
3628
|
<dd>
|
|
3746
3629
|
|
|
3747
|
-
**
|
|
3630
|
+
**page:** `Integer`
|
|
3748
3631
|
|
|
3749
3632
|
</dd>
|
|
3750
3633
|
</dl>
|
|
@@ -3752,7 +3635,7 @@ client.partners.create(name: "name")
|
|
|
3752
3635
|
<dl>
|
|
3753
3636
|
<dd>
|
|
3754
3637
|
|
|
3755
|
-
**
|
|
3638
|
+
**page_size:** `Integer`
|
|
3756
3639
|
|
|
3757
3640
|
</dd>
|
|
3758
3641
|
</dl>
|
|
@@ -3760,7 +3643,7 @@ client.partners.create(name: "name")
|
|
|
3760
3643
|
<dl>
|
|
3761
3644
|
<dd>
|
|
3762
3645
|
|
|
3763
|
-
**
|
|
3646
|
+
**sort:** `Internal::Types::Array[Nordlet::Partners::Types::VatReviewsListPartnersRequestSortItem]`
|
|
3764
3647
|
|
|
3765
3648
|
</dd>
|
|
3766
3649
|
</dl>
|
|
@@ -3768,7 +3651,7 @@ client.partners.create(name: "name")
|
|
|
3768
3651
|
<dl>
|
|
3769
3652
|
<dd>
|
|
3770
3653
|
|
|
3771
|
-
**
|
|
3654
|
+
**filter:** `Internal::Types::Array[Nordlet::Partners::Types::VatReviewsListPartnersRequestFilterItem]`
|
|
3772
3655
|
|
|
3773
3656
|
</dd>
|
|
3774
3657
|
</dl>
|
|
@@ -3776,7 +3659,7 @@ client.partners.create(name: "name")
|
|
|
3776
3659
|
<dl>
|
|
3777
3660
|
<dd>
|
|
3778
3661
|
|
|
3779
|
-
**
|
|
3662
|
+
**totals:** `Internal::Types::Array[String]` — Numeric fields to sum over every row matching the filter (not only the current page)
|
|
3780
3663
|
|
|
3781
3664
|
</dd>
|
|
3782
3665
|
</dl>
|
|
@@ -3784,95 +3667,64 @@ client.partners.create(name: "name")
|
|
|
3784
3667
|
<dl>
|
|
3785
3668
|
<dd>
|
|
3786
3669
|
|
|
3787
|
-
**
|
|
3670
|
+
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
3788
3671
|
|
|
3789
3672
|
</dd>
|
|
3790
3673
|
</dl>
|
|
3791
|
-
|
|
3792
|
-
<dl>
|
|
3793
|
-
<dd>
|
|
3794
|
-
|
|
3795
|
-
**website:** `String`
|
|
3796
|
-
|
|
3797
3674
|
</dd>
|
|
3798
3675
|
</dl>
|
|
3799
3676
|
|
|
3800
|
-
<dl>
|
|
3801
|
-
<dd>
|
|
3802
3677
|
|
|
3803
|
-
**fax:** `String`
|
|
3804
|
-
|
|
3805
3678
|
</dd>
|
|
3806
3679
|
</dl>
|
|
3680
|
+
</details>
|
|
3807
3681
|
|
|
3682
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">vat_reviews_resolve</a>(request) -> Nordlet::Partners::Types::VatReviewsResolvePartnersResponse</code></summary>
|
|
3808
3683
|
<dl>
|
|
3809
3684
|
<dd>
|
|
3810
3685
|
|
|
3811
|
-
|
|
3812
|
-
|
|
3813
|
-
</dd>
|
|
3814
|
-
</dl>
|
|
3686
|
+
#### 📝 Description
|
|
3815
3687
|
|
|
3816
3688
|
<dl>
|
|
3817
3689
|
<dd>
|
|
3818
3690
|
|
|
3819
|
-
**auto_debt_reminder:** `Internal::Types::Boolean`
|
|
3820
|
-
|
|
3821
|
-
</dd>
|
|
3822
|
-
</dl>
|
|
3823
|
-
|
|
3824
3691
|
<dl>
|
|
3825
3692
|
<dd>
|
|
3826
3693
|
|
|
3827
|
-
|
|
3828
|
-
|
|
3694
|
+
Closes an open VAT review as `confirmed_valid`, `confirmed_invalid` or `dismissed`, with an optional note. The first two also set the partner's `vatValid` and stamp `vatValidatedAt` when the partner still carries the reviewed VAT code; `dismissed` leaves the partner unchanged. A review that is already resolved answers 409; emits `vat_review.resolved`.
|
|
3829
3695
|
</dd>
|
|
3830
3696
|
</dl>
|
|
3831
|
-
|
|
3832
|
-
<dl>
|
|
3833
|
-
<dd>
|
|
3834
|
-
|
|
3835
|
-
**first_call_date:** `String`
|
|
3836
|
-
|
|
3837
3697
|
</dd>
|
|
3838
3698
|
</dl>
|
|
3839
3699
|
|
|
3700
|
+
#### 🔌 Usage
|
|
3701
|
+
|
|
3840
3702
|
<dl>
|
|
3841
3703
|
<dd>
|
|
3842
3704
|
|
|
3843
|
-
**last_call_date:** `String`
|
|
3844
|
-
|
|
3845
|
-
</dd>
|
|
3846
|
-
</dl>
|
|
3847
|
-
|
|
3848
3705
|
<dl>
|
|
3849
3706
|
<dd>
|
|
3850
3707
|
|
|
3851
|
-
|
|
3852
|
-
|
|
3708
|
+
```ruby
|
|
3709
|
+
client.partners.vat_reviews_resolve(
|
|
3710
|
+
id: "id",
|
|
3711
|
+
resolution: "confirmed_valid"
|
|
3712
|
+
)
|
|
3713
|
+
```
|
|
3853
3714
|
</dd>
|
|
3854
3715
|
</dl>
|
|
3855
|
-
|
|
3856
|
-
<dl>
|
|
3857
|
-
<dd>
|
|
3858
|
-
|
|
3859
|
-
**rating:** `Integer`
|
|
3860
|
-
|
|
3861
3716
|
</dd>
|
|
3862
3717
|
</dl>
|
|
3863
3718
|
|
|
3719
|
+
#### ⚙️ Parameters
|
|
3720
|
+
|
|
3864
3721
|
<dl>
|
|
3865
3722
|
<dd>
|
|
3866
3723
|
|
|
3867
|
-
**is_employee:** `Internal::Types::Boolean`
|
|
3868
|
-
|
|
3869
|
-
</dd>
|
|
3870
|
-
</dl>
|
|
3871
|
-
|
|
3872
3724
|
<dl>
|
|
3873
3725
|
<dd>
|
|
3874
3726
|
|
|
3875
|
-
**
|
|
3727
|
+
**id:** `String`
|
|
3876
3728
|
|
|
3877
3729
|
</dd>
|
|
3878
3730
|
</dl>
|
|
@@ -3880,7 +3732,7 @@ client.partners.create(name: "name")
|
|
|
3880
3732
|
<dl>
|
|
3881
3733
|
<dd>
|
|
3882
3734
|
|
|
3883
|
-
**
|
|
3735
|
+
**resolution:** `Nordlet::Partners::Types::VatReviewsResolvePartnersRequestResolution`
|
|
3884
3736
|
|
|
3885
3737
|
</dd>
|
|
3886
3738
|
</dl>
|
|
@@ -3888,7 +3740,7 @@ client.partners.create(name: "name")
|
|
|
3888
3740
|
<dl>
|
|
3889
3741
|
<dd>
|
|
3890
3742
|
|
|
3891
|
-
**
|
|
3743
|
+
**note:** `String`
|
|
3892
3744
|
|
|
3893
3745
|
</dd>
|
|
3894
3746
|
</dl>
|
|
@@ -3908,7 +3760,7 @@ client.partners.create(name: "name")
|
|
|
3908
3760
|
</dl>
|
|
3909
3761
|
</details>
|
|
3910
3762
|
|
|
3911
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
3763
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">create</a>(request) -> Nordlet::Partners::Types::CreatePartnersResponse</code></summary>
|
|
3912
3764
|
<dl>
|
|
3913
3765
|
<dd>
|
|
3914
3766
|
|
|
@@ -3920,7 +3772,7 @@ client.partners.create(name: "name")
|
|
|
3920
3772
|
<dl>
|
|
3921
3773
|
<dd>
|
|
3922
3774
|
|
|
3923
|
-
|
|
3775
|
+
Creates a partner. `groupId`, `statusId` and `priceListId` must belong to the company; without `legalCountryClass` the class is derived from the address country (`lt`, `eu` or `non_eu`); `documentRef` attaches an uploaded file that is not yet linked to a record; a `code` already used by a live partner of the company is refused with 409. A `vatCode` is checked against VIES at once and the result stored on the partner: an invalid number, a VIES name that shares no word with the partner's name, or a VIES failure opens a VAT review (`vat_review.opened`), while a code that is not an EU VAT number is stored unchecked (see `partners/validate-vat`).
|
|
3924
3776
|
</dd>
|
|
3925
3777
|
</dl>
|
|
3926
3778
|
</dd>
|
|
@@ -3935,7 +3787,7 @@ Returns the live partner matched by `code`, then `vatCode`, then `email` (at lea
|
|
|
3935
3787
|
<dd>
|
|
3936
3788
|
|
|
3937
3789
|
```ruby
|
|
3938
|
-
client.partners.
|
|
3790
|
+
client.partners.create(name: "name")
|
|
3939
3791
|
```
|
|
3940
3792
|
</dd>
|
|
3941
3793
|
</dl>
|
|
@@ -3950,7 +3802,7 @@ client.partners.find_or_create(name: "name")
|
|
|
3950
3802
|
<dl>
|
|
3951
3803
|
<dd>
|
|
3952
3804
|
|
|
3953
|
-
**type:** `Nordlet::Partners::Types::
|
|
3805
|
+
**type:** `Nordlet::Partners::Types::CreatePartnersRequestType`
|
|
3954
3806
|
|
|
3955
3807
|
</dd>
|
|
3956
3808
|
</dl>
|
|
@@ -4046,6 +3898,22 @@ client.partners.find_or_create(name: "name")
|
|
|
4046
3898
|
<dl>
|
|
4047
3899
|
<dd>
|
|
4048
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
|
+
|
|
4049
3917
|
**credit_limit:** `String`
|
|
4050
3918
|
|
|
4051
3919
|
</dd>
|
|
@@ -4078,7 +3946,7 @@ client.partners.find_or_create(name: "name")
|
|
|
4078
3946
|
<dl>
|
|
4079
3947
|
<dd>
|
|
4080
3948
|
|
|
4081
|
-
**address:** `Nordlet::Partners::Types::
|
|
3949
|
+
**address:** `Nordlet::Partners::Types::CreatePartnersRequestAddress`
|
|
4082
3950
|
|
|
4083
3951
|
</dd>
|
|
4084
3952
|
</dl>
|
|
@@ -4086,7 +3954,7 @@ client.partners.find_or_create(name: "name")
|
|
|
4086
3954
|
<dl>
|
|
4087
3955
|
<dd>
|
|
4088
3956
|
|
|
4089
|
-
**correspondence_address:** `Nordlet::Partners::Types::
|
|
3957
|
+
**correspondence_address:** `Nordlet::Partners::Types::CreatePartnersRequestCorrespondenceAddress`
|
|
4090
3958
|
|
|
4091
3959
|
</dd>
|
|
4092
3960
|
</dl>
|
|
@@ -4214,7 +4082,7 @@ client.partners.find_or_create(name: "name")
|
|
|
4214
4082
|
<dl>
|
|
4215
4083
|
<dd>
|
|
4216
4084
|
|
|
4217
|
-
**legal_country_class:** `Nordlet::Partners::Types::
|
|
4085
|
+
**legal_country_class:** `Nordlet::Partners::Types::CreatePartnersRequestLegalCountryClass`
|
|
4218
4086
|
|
|
4219
4087
|
</dd>
|
|
4220
4088
|
</dl>
|
|
@@ -4234,7 +4102,7 @@ client.partners.find_or_create(name: "name")
|
|
|
4234
4102
|
</dl>
|
|
4235
4103
|
</details>
|
|
4236
4104
|
|
|
4237
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
4105
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">find_or_create</a>(request) -> Nordlet::Partners::Types::FindOrCreatePartnersResponse</code></summary>
|
|
4238
4106
|
<dl>
|
|
4239
4107
|
<dd>
|
|
4240
4108
|
|
|
@@ -4246,7 +4114,7 @@ client.partners.find_or_create(name: "name")
|
|
|
4246
4114
|
<dl>
|
|
4247
4115
|
<dd>
|
|
4248
4116
|
|
|
4249
|
-
Returns
|
|
4117
|
+
Returns the live partner matched by `code`, then `vatCode`, then `email` (at least one is required), or creates one from the body with the same validation and VIES check as `partners/create`; `created` says which happened. A creation that loses a race on the partner code returns the partner the other call created.
|
|
4250
4118
|
</dd>
|
|
4251
4119
|
</dl>
|
|
4252
4120
|
</dd>
|
|
@@ -4261,7 +4129,7 @@ Returns one partner; a deleted partner answers 404.
|
|
|
4261
4129
|
<dd>
|
|
4262
4130
|
|
|
4263
4131
|
```ruby
|
|
4264
|
-
client.partners.
|
|
4132
|
+
client.partners.find_or_create(name: "name")
|
|
4265
4133
|
```
|
|
4266
4134
|
</dd>
|
|
4267
4135
|
</dl>
|
|
@@ -4276,69 +4144,15 @@ client.partners.get(id: "id")
|
|
|
4276
4144
|
<dl>
|
|
4277
4145
|
<dd>
|
|
4278
4146
|
|
|
4279
|
-
**
|
|
4280
|
-
|
|
4281
|
-
</dd>
|
|
4282
|
-
</dl>
|
|
4283
|
-
|
|
4284
|
-
<dl>
|
|
4285
|
-
<dd>
|
|
4286
|
-
|
|
4287
|
-
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
4147
|
+
**type:** `Nordlet::Partners::Types::FindOrCreatePartnersRequestType`
|
|
4288
4148
|
|
|
4289
4149
|
</dd>
|
|
4290
4150
|
</dl>
|
|
4291
|
-
</dd>
|
|
4292
|
-
</dl>
|
|
4293
|
-
|
|
4294
|
-
|
|
4295
|
-
</dd>
|
|
4296
|
-
</dl>
|
|
4297
|
-
</details>
|
|
4298
4151
|
|
|
4299
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">update</a>(request) -> Nordlet::Partners::Types::UpdatePartnersResponse</code></summary>
|
|
4300
4152
|
<dl>
|
|
4301
4153
|
<dd>
|
|
4302
4154
|
|
|
4303
|
-
|
|
4304
|
-
|
|
4305
|
-
<dl>
|
|
4306
|
-
<dd>
|
|
4307
|
-
|
|
4308
|
-
<dl>
|
|
4309
|
-
<dd>
|
|
4310
|
-
|
|
4311
|
-
Changes the given fields of a partner; the clearable fields accept null. A new address country re-derives `legalCountryClass` unless the class is given, and a `code` already used by another live partner of the company is refused with 409. A changed `vatCode` resets the VIES result and is checked at once as in `partners/create`; a removed code, or one that is not an EU VAT number, resolves the partner's open VAT review as `superseded` (`vat_review.resolved`).
|
|
4312
|
-
</dd>
|
|
4313
|
-
</dl>
|
|
4314
|
-
</dd>
|
|
4315
|
-
</dl>
|
|
4316
|
-
|
|
4317
|
-
#### 🔌 Usage
|
|
4318
|
-
|
|
4319
|
-
<dl>
|
|
4320
|
-
<dd>
|
|
4321
|
-
|
|
4322
|
-
<dl>
|
|
4323
|
-
<dd>
|
|
4324
|
-
|
|
4325
|
-
```ruby
|
|
4326
|
-
client.partners.update(id: "id")
|
|
4327
|
-
```
|
|
4328
|
-
</dd>
|
|
4329
|
-
</dl>
|
|
4330
|
-
</dd>
|
|
4331
|
-
</dl>
|
|
4332
|
-
|
|
4333
|
-
#### ⚙️ Parameters
|
|
4334
|
-
|
|
4335
|
-
<dl>
|
|
4336
|
-
<dd>
|
|
4337
|
-
|
|
4338
|
-
<dl>
|
|
4339
|
-
<dd>
|
|
4340
|
-
|
|
4341
|
-
**id:** `String`
|
|
4155
|
+
**name:** `String`
|
|
4342
4156
|
|
|
4343
4157
|
</dd>
|
|
4344
4158
|
</dl>
|
|
@@ -4346,7 +4160,7 @@ client.partners.update(id: "id")
|
|
|
4346
4160
|
<dl>
|
|
4347
4161
|
<dd>
|
|
4348
4162
|
|
|
4349
|
-
**
|
|
4163
|
+
**code:** `String`
|
|
4350
4164
|
|
|
4351
4165
|
</dd>
|
|
4352
4166
|
</dl>
|
|
@@ -4354,7 +4168,7 @@ client.partners.update(id: "id")
|
|
|
4354
4168
|
<dl>
|
|
4355
4169
|
<dd>
|
|
4356
4170
|
|
|
4357
|
-
**
|
|
4171
|
+
**vat_code:** `String`
|
|
4358
4172
|
|
|
4359
4173
|
</dd>
|
|
4360
4174
|
</dl>
|
|
@@ -4362,7 +4176,7 @@ client.partners.update(id: "id")
|
|
|
4362
4176
|
<dl>
|
|
4363
4177
|
<dd>
|
|
4364
4178
|
|
|
4365
|
-
**
|
|
4179
|
+
**peppol_id:** `String`
|
|
4366
4180
|
|
|
4367
4181
|
</dd>
|
|
4368
4182
|
</dl>
|
|
@@ -4370,7 +4184,7 @@ client.partners.update(id: "id")
|
|
|
4370
4184
|
<dl>
|
|
4371
4185
|
<dd>
|
|
4372
4186
|
|
|
4373
|
-
**
|
|
4187
|
+
**email:** `String`
|
|
4374
4188
|
|
|
4375
4189
|
</dd>
|
|
4376
4190
|
</dl>
|
|
@@ -4378,7 +4192,7 @@ client.partners.update(id: "id")
|
|
|
4378
4192
|
<dl>
|
|
4379
4193
|
<dd>
|
|
4380
4194
|
|
|
4381
|
-
**
|
|
4195
|
+
**phone:** `String`
|
|
4382
4196
|
|
|
4383
4197
|
</dd>
|
|
4384
4198
|
</dl>
|
|
@@ -4386,7 +4200,7 @@ client.partners.update(id: "id")
|
|
|
4386
4200
|
<dl>
|
|
4387
4201
|
<dd>
|
|
4388
4202
|
|
|
4389
|
-
**
|
|
4203
|
+
**self_employment_cert_no:** `String`
|
|
4390
4204
|
|
|
4391
4205
|
</dd>
|
|
4392
4206
|
</dl>
|
|
@@ -4394,7 +4208,7 @@ client.partners.update(id: "id")
|
|
|
4394
4208
|
<dl>
|
|
4395
4209
|
<dd>
|
|
4396
4210
|
|
|
4397
|
-
**
|
|
4211
|
+
**birth_date:** `String`
|
|
4398
4212
|
|
|
4399
4213
|
</dd>
|
|
4400
4214
|
</dl>
|
|
@@ -4402,7 +4216,7 @@ client.partners.update(id: "id")
|
|
|
4402
4216
|
<dl>
|
|
4403
4217
|
<dd>
|
|
4404
4218
|
|
|
4405
|
-
**
|
|
4219
|
+
**is_customer:** `Internal::Types::Boolean`
|
|
4406
4220
|
|
|
4407
4221
|
</dd>
|
|
4408
4222
|
</dl>
|
|
@@ -4410,7 +4224,7 @@ client.partners.update(id: "id")
|
|
|
4410
4224
|
<dl>
|
|
4411
4225
|
<dd>
|
|
4412
4226
|
|
|
4413
|
-
**
|
|
4227
|
+
**is_supplier:** `Internal::Types::Boolean`
|
|
4414
4228
|
|
|
4415
4229
|
</dd>
|
|
4416
4230
|
</dl>
|
|
@@ -4418,7 +4232,7 @@ client.partners.update(id: "id")
|
|
|
4418
4232
|
<dl>
|
|
4419
4233
|
<dd>
|
|
4420
4234
|
|
|
4421
|
-
**
|
|
4235
|
+
**payment_term_days:** `Integer`
|
|
4422
4236
|
|
|
4423
4237
|
</dd>
|
|
4424
4238
|
</dl>
|
|
@@ -4426,7 +4240,7 @@ client.partners.update(id: "id")
|
|
|
4426
4240
|
<dl>
|
|
4427
4241
|
<dd>
|
|
4428
4242
|
|
|
4429
|
-
**
|
|
4243
|
+
**invoice_currency:** `Nordlet::Partners::Types::FindOrCreatePartnersRequestInvoiceCurrency` — Currency a new invoice for this partner starts with when the invoice names none
|
|
4430
4244
|
|
|
4431
4245
|
</dd>
|
|
4432
4246
|
</dl>
|
|
@@ -4434,7 +4248,7 @@ client.partners.update(id: "id")
|
|
|
4434
4248
|
<dl>
|
|
4435
4249
|
<dd>
|
|
4436
4250
|
|
|
4437
|
-
**
|
|
4251
|
+
**invoice_locale:** `Nordlet::Partners::Types::FindOrCreatePartnersRequestInvoiceLocale` — Language a new invoice for this partner starts with when the invoice names none
|
|
4438
4252
|
|
|
4439
4253
|
</dd>
|
|
4440
4254
|
</dl>
|
|
@@ -4474,7 +4288,7 @@ client.partners.update(id: "id")
|
|
|
4474
4288
|
<dl>
|
|
4475
4289
|
<dd>
|
|
4476
4290
|
|
|
4477
|
-
**address:** `Nordlet::Partners::Types::
|
|
4291
|
+
**address:** `Nordlet::Partners::Types::FindOrCreatePartnersRequestAddress`
|
|
4478
4292
|
|
|
4479
4293
|
</dd>
|
|
4480
4294
|
</dl>
|
|
@@ -4482,7 +4296,7 @@ client.partners.update(id: "id")
|
|
|
4482
4296
|
<dl>
|
|
4483
4297
|
<dd>
|
|
4484
4298
|
|
|
4485
|
-
**correspondence_address:** `Nordlet::Partners::Types::
|
|
4299
|
+
**correspondence_address:** `Nordlet::Partners::Types::FindOrCreatePartnersRequestCorrespondenceAddress`
|
|
4486
4300
|
|
|
4487
4301
|
</dd>
|
|
4488
4302
|
</dl>
|
|
@@ -4610,7 +4424,7 @@ client.partners.update(id: "id")
|
|
|
4610
4424
|
<dl>
|
|
4611
4425
|
<dd>
|
|
4612
4426
|
|
|
4613
|
-
**legal_country_class:** `Nordlet::Partners::Types::
|
|
4427
|
+
**legal_country_class:** `Nordlet::Partners::Types::FindOrCreatePartnersRequestLegalCountryClass`
|
|
4614
4428
|
|
|
4615
4429
|
</dd>
|
|
4616
4430
|
</dl>
|
|
@@ -4630,7 +4444,7 @@ client.partners.update(id: "id")
|
|
|
4630
4444
|
</dl>
|
|
4631
4445
|
</details>
|
|
4632
4446
|
|
|
4633
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
4447
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">get</a>(request) -> Nordlet::Partners::Types::GetPartnersResponse</code></summary>
|
|
4634
4448
|
<dl>
|
|
4635
4449
|
<dd>
|
|
4636
4450
|
|
|
@@ -4642,7 +4456,7 @@ client.partners.update(id: "id")
|
|
|
4642
4456
|
<dl>
|
|
4643
4457
|
<dd>
|
|
4644
4458
|
|
|
4645
|
-
|
|
4459
|
+
Returns one partner; a deleted partner answers 404.
|
|
4646
4460
|
</dd>
|
|
4647
4461
|
</dl>
|
|
4648
4462
|
</dd>
|
|
@@ -4657,7 +4471,7 @@ Marks a partner as deleted; it no longer appears in lists or lookups.
|
|
|
4657
4471
|
<dd>
|
|
4658
4472
|
|
|
4659
4473
|
```ruby
|
|
4660
|
-
client.partners.
|
|
4474
|
+
client.partners.get(id: "id")
|
|
4661
4475
|
```
|
|
4662
4476
|
</dd>
|
|
4663
4477
|
</dl>
|
|
@@ -4692,7 +4506,7 @@ client.partners.delete(id: "id")
|
|
|
4692
4506
|
</dl>
|
|
4693
4507
|
</details>
|
|
4694
4508
|
|
|
4695
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
4509
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">update</a>(request) -> Nordlet::Partners::Types::UpdatePartnersResponse</code></summary>
|
|
4696
4510
|
<dl>
|
|
4697
4511
|
<dd>
|
|
4698
4512
|
|
|
@@ -4704,7 +4518,7 @@ client.partners.delete(id: "id")
|
|
|
4704
4518
|
<dl>
|
|
4705
4519
|
<dd>
|
|
4706
4520
|
|
|
4707
|
-
|
|
4521
|
+
Changes the given fields of a partner; the clearable fields accept null. A new address country re-derives `legalCountryClass` unless the class is given, and a `code` already used by another live partner of the company is refused with 409. A changed `vatCode` resets the VIES result and is checked at once as in `partners/create`; a removed code, or one that is not an EU VAT number, resolves the partner's open VAT review as `superseded` (`vat_review.resolved`).
|
|
4708
4522
|
</dd>
|
|
4709
4523
|
</dl>
|
|
4710
4524
|
</dd>
|
|
@@ -4719,10 +4533,7 @@ Moves every row that references the duplicate `sourceId` through a foreign key t
|
|
|
4719
4533
|
<dd>
|
|
4720
4534
|
|
|
4721
4535
|
```ruby
|
|
4722
|
-
client.partners.
|
|
4723
|
-
source_id: "sourceId",
|
|
4724
|
-
target_id: "targetId"
|
|
4725
|
-
)
|
|
4536
|
+
client.partners.update(id: "id")
|
|
4726
4537
|
```
|
|
4727
4538
|
</dd>
|
|
4728
4539
|
</dl>
|
|
@@ -4737,7 +4548,7 @@ client.partners.merge(
|
|
|
4737
4548
|
<dl>
|
|
4738
4549
|
<dd>
|
|
4739
4550
|
|
|
4740
|
-
**
|
|
4551
|
+
**id:** `String`
|
|
4741
4552
|
|
|
4742
4553
|
</dd>
|
|
4743
4554
|
</dl>
|
|
@@ -4745,7 +4556,7 @@ client.partners.merge(
|
|
|
4745
4556
|
<dl>
|
|
4746
4557
|
<dd>
|
|
4747
4558
|
|
|
4748
|
-
**
|
|
4559
|
+
**type:** `Nordlet::Partners::Types::UpdatePartnersRequestType`
|
|
4749
4560
|
|
|
4750
4561
|
</dd>
|
|
4751
4562
|
</dl>
|
|
@@ -4753,61 +4564,71 @@ client.partners.merge(
|
|
|
4753
4564
|
<dl>
|
|
4754
4565
|
<dd>
|
|
4755
4566
|
|
|
4756
|
-
**
|
|
4567
|
+
**name:** `String`
|
|
4757
4568
|
|
|
4758
4569
|
</dd>
|
|
4759
4570
|
</dl>
|
|
4760
|
-
</dd>
|
|
4761
|
-
</dl>
|
|
4762
4571
|
|
|
4572
|
+
<dl>
|
|
4573
|
+
<dd>
|
|
4763
4574
|
|
|
4575
|
+
**code:** `String`
|
|
4576
|
+
|
|
4764
4577
|
</dd>
|
|
4765
4578
|
</dl>
|
|
4766
|
-
</details>
|
|
4767
4579
|
|
|
4768
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">anonymize</a>(request) -> Nordlet::Partners::Types::AnonymizePartnersResponse</code></summary>
|
|
4769
4580
|
<dl>
|
|
4770
4581
|
<dd>
|
|
4771
4582
|
|
|
4772
|
-
|
|
4583
|
+
**vat_code:** `String`
|
|
4584
|
+
|
|
4585
|
+
</dd>
|
|
4586
|
+
</dl>
|
|
4773
4587
|
|
|
4774
4588
|
<dl>
|
|
4775
4589
|
<dd>
|
|
4776
4590
|
|
|
4591
|
+
**peppol_id:** `String`
|
|
4592
|
+
|
|
4593
|
+
</dd>
|
|
4594
|
+
</dl>
|
|
4595
|
+
|
|
4777
4596
|
<dl>
|
|
4778
4597
|
<dd>
|
|
4779
4598
|
|
|
4780
|
-
|
|
4781
|
-
|
|
4782
|
-
</dl>
|
|
4599
|
+
**email:** `String`
|
|
4600
|
+
|
|
4783
4601
|
</dd>
|
|
4784
4602
|
</dl>
|
|
4785
4603
|
|
|
4786
|
-
#### 🔌 Usage
|
|
4787
|
-
|
|
4788
4604
|
<dl>
|
|
4789
4605
|
<dd>
|
|
4790
4606
|
|
|
4607
|
+
**phone:** `String`
|
|
4608
|
+
|
|
4609
|
+
</dd>
|
|
4610
|
+
</dl>
|
|
4611
|
+
|
|
4791
4612
|
<dl>
|
|
4792
4613
|
<dd>
|
|
4793
4614
|
|
|
4794
|
-
|
|
4795
|
-
|
|
4796
|
-
```
|
|
4797
|
-
</dd>
|
|
4798
|
-
</dl>
|
|
4615
|
+
**self_employment_cert_no:** `String`
|
|
4616
|
+
|
|
4799
4617
|
</dd>
|
|
4800
4618
|
</dl>
|
|
4801
4619
|
|
|
4802
|
-
#### ⚙️ Parameters
|
|
4803
|
-
|
|
4804
4620
|
<dl>
|
|
4805
4621
|
<dd>
|
|
4806
4622
|
|
|
4623
|
+
**birth_date:** `String`
|
|
4624
|
+
|
|
4625
|
+
</dd>
|
|
4626
|
+
</dl>
|
|
4627
|
+
|
|
4807
4628
|
<dl>
|
|
4808
4629
|
<dd>
|
|
4809
4630
|
|
|
4810
|
-
**
|
|
4631
|
+
**is_customer:** `Internal::Types::Boolean`
|
|
4811
4632
|
|
|
4812
4633
|
</dd>
|
|
4813
4634
|
</dl>
|
|
@@ -4815,61 +4636,71 @@ client.partners.anonymize(id: "id")
|
|
|
4815
4636
|
<dl>
|
|
4816
4637
|
<dd>
|
|
4817
4638
|
|
|
4818
|
-
**
|
|
4639
|
+
**is_supplier:** `Internal::Types::Boolean`
|
|
4819
4640
|
|
|
4820
4641
|
</dd>
|
|
4821
4642
|
</dl>
|
|
4822
|
-
</dd>
|
|
4823
|
-
</dl>
|
|
4824
4643
|
|
|
4644
|
+
<dl>
|
|
4645
|
+
<dd>
|
|
4825
4646
|
|
|
4647
|
+
**payment_term_days:** `Integer`
|
|
4648
|
+
|
|
4826
4649
|
</dd>
|
|
4827
4650
|
</dl>
|
|
4828
|
-
</details>
|
|
4829
4651
|
|
|
4830
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">list</a>(request) -> Nordlet::Partners::Types::ListPartnersResponse</code></summary>
|
|
4831
4652
|
<dl>
|
|
4832
4653
|
<dd>
|
|
4833
4654
|
|
|
4834
|
-
|
|
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>
|
|
4835
4659
|
|
|
4836
4660
|
<dl>
|
|
4837
4661
|
<dd>
|
|
4838
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
|
+
|
|
4839
4668
|
<dl>
|
|
4840
4669
|
<dd>
|
|
4841
4670
|
|
|
4842
|
-
|
|
4843
|
-
|
|
4844
|
-
</dl>
|
|
4671
|
+
**credit_limit:** `String`
|
|
4672
|
+
|
|
4845
4673
|
</dd>
|
|
4846
4674
|
</dl>
|
|
4847
4675
|
|
|
4848
|
-
#### 🔌 Usage
|
|
4849
|
-
|
|
4850
4676
|
<dl>
|
|
4851
4677
|
<dd>
|
|
4852
4678
|
|
|
4679
|
+
**price_list_id:** `String`
|
|
4680
|
+
|
|
4681
|
+
</dd>
|
|
4682
|
+
</dl>
|
|
4683
|
+
|
|
4853
4684
|
<dl>
|
|
4854
4685
|
<dd>
|
|
4855
4686
|
|
|
4856
|
-
|
|
4857
|
-
|
|
4858
|
-
```
|
|
4859
|
-
</dd>
|
|
4860
|
-
</dl>
|
|
4687
|
+
**group_id:** `String`
|
|
4688
|
+
|
|
4861
4689
|
</dd>
|
|
4862
4690
|
</dl>
|
|
4863
4691
|
|
|
4864
|
-
#### ⚙️ Parameters
|
|
4865
|
-
|
|
4866
4692
|
<dl>
|
|
4867
4693
|
<dd>
|
|
4868
4694
|
|
|
4695
|
+
**status_id:** `String`
|
|
4696
|
+
|
|
4697
|
+
</dd>
|
|
4698
|
+
</dl>
|
|
4699
|
+
|
|
4869
4700
|
<dl>
|
|
4870
4701
|
<dd>
|
|
4871
4702
|
|
|
4872
|
-
**
|
|
4703
|
+
**address:** `Nordlet::Partners::Types::UpdatePartnersRequestAddress`
|
|
4873
4704
|
|
|
4874
4705
|
</dd>
|
|
4875
4706
|
</dl>
|
|
@@ -4877,7 +4708,7 @@ client.partners.list
|
|
|
4877
4708
|
<dl>
|
|
4878
4709
|
<dd>
|
|
4879
4710
|
|
|
4880
|
-
**
|
|
4711
|
+
**correspondence_address:** `Nordlet::Partners::Types::UpdatePartnersRequestCorrespondenceAddress`
|
|
4881
4712
|
|
|
4882
4713
|
</dd>
|
|
4883
4714
|
</dl>
|
|
@@ -4885,7 +4716,7 @@ client.partners.list
|
|
|
4885
4716
|
<dl>
|
|
4886
4717
|
<dd>
|
|
4887
4718
|
|
|
4888
|
-
**
|
|
4719
|
+
**notes:** `String`
|
|
4889
4720
|
|
|
4890
4721
|
</dd>
|
|
4891
4722
|
</dl>
|
|
@@ -4893,7 +4724,7 @@ client.partners.list
|
|
|
4893
4724
|
<dl>
|
|
4894
4725
|
<dd>
|
|
4895
4726
|
|
|
4896
|
-
**
|
|
4727
|
+
**document_ref:** `String`
|
|
4897
4728
|
|
|
4898
4729
|
</dd>
|
|
4899
4730
|
</dl>
|
|
@@ -4901,7 +4732,7 @@ client.partners.list
|
|
|
4901
4732
|
<dl>
|
|
4902
4733
|
<dd>
|
|
4903
4734
|
|
|
4904
|
-
**
|
|
4735
|
+
**short_name:** `String`
|
|
4905
4736
|
|
|
4906
4737
|
</dd>
|
|
4907
4738
|
</dl>
|
|
@@ -4909,64 +4740,95 @@ client.partners.list
|
|
|
4909
4740
|
<dl>
|
|
4910
4741
|
<dd>
|
|
4911
4742
|
|
|
4912
|
-
**
|
|
4743
|
+
**website:** `String`
|
|
4913
4744
|
|
|
4914
4745
|
</dd>
|
|
4915
4746
|
</dl>
|
|
4747
|
+
|
|
4748
|
+
<dl>
|
|
4749
|
+
<dd>
|
|
4750
|
+
|
|
4751
|
+
**fax:** `String`
|
|
4752
|
+
|
|
4916
4753
|
</dd>
|
|
4917
4754
|
</dl>
|
|
4918
4755
|
|
|
4756
|
+
<dl>
|
|
4757
|
+
<dd>
|
|
4919
4758
|
|
|
4759
|
+
**eori_code:** `String`
|
|
4760
|
+
|
|
4920
4761
|
</dd>
|
|
4921
4762
|
</dl>
|
|
4922
|
-
</details>
|
|
4923
4763
|
|
|
4924
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">groups_create</a>(request) -> Nordlet::Partners::Types::GroupsCreatePartnersResponse</code></summary>
|
|
4925
4764
|
<dl>
|
|
4926
4765
|
<dd>
|
|
4927
4766
|
|
|
4928
|
-
|
|
4767
|
+
**auto_debt_reminder:** `Internal::Types::Boolean`
|
|
4768
|
+
|
|
4769
|
+
</dd>
|
|
4770
|
+
</dl>
|
|
4929
4771
|
|
|
4930
4772
|
<dl>
|
|
4931
4773
|
<dd>
|
|
4932
4774
|
|
|
4775
|
+
**late_interest_percent:** `String`
|
|
4776
|
+
|
|
4777
|
+
</dd>
|
|
4778
|
+
</dl>
|
|
4779
|
+
|
|
4933
4780
|
<dl>
|
|
4934
4781
|
<dd>
|
|
4935
4782
|
|
|
4936
|
-
|
|
4783
|
+
**first_call_date:** `String`
|
|
4784
|
+
|
|
4937
4785
|
</dd>
|
|
4938
4786
|
</dl>
|
|
4787
|
+
|
|
4788
|
+
<dl>
|
|
4789
|
+
<dd>
|
|
4790
|
+
|
|
4791
|
+
**last_call_date:** `String`
|
|
4792
|
+
|
|
4939
4793
|
</dd>
|
|
4940
4794
|
</dl>
|
|
4941
4795
|
|
|
4942
|
-
#### 🔌 Usage
|
|
4943
|
-
|
|
4944
4796
|
<dl>
|
|
4945
4797
|
<dd>
|
|
4946
4798
|
|
|
4799
|
+
**next_call_date:** `String`
|
|
4800
|
+
|
|
4801
|
+
</dd>
|
|
4802
|
+
</dl>
|
|
4803
|
+
|
|
4947
4804
|
<dl>
|
|
4948
4805
|
<dd>
|
|
4949
4806
|
|
|
4950
|
-
|
|
4951
|
-
|
|
4952
|
-
code: "code",
|
|
4953
|
-
name: "name"
|
|
4954
|
-
)
|
|
4955
|
-
```
|
|
4807
|
+
**rating:** `Integer`
|
|
4808
|
+
|
|
4956
4809
|
</dd>
|
|
4957
4810
|
</dl>
|
|
4811
|
+
|
|
4812
|
+
<dl>
|
|
4813
|
+
<dd>
|
|
4814
|
+
|
|
4815
|
+
**is_employee:** `Internal::Types::Boolean`
|
|
4816
|
+
|
|
4958
4817
|
</dd>
|
|
4959
4818
|
</dl>
|
|
4960
4819
|
|
|
4961
|
-
#### ⚙️ Parameters
|
|
4962
|
-
|
|
4963
4820
|
<dl>
|
|
4964
4821
|
<dd>
|
|
4965
4822
|
|
|
4823
|
+
**is_group_member:** `Internal::Types::Boolean`
|
|
4824
|
+
|
|
4825
|
+
</dd>
|
|
4826
|
+
</dl>
|
|
4827
|
+
|
|
4966
4828
|
<dl>
|
|
4967
4829
|
<dd>
|
|
4968
4830
|
|
|
4969
|
-
**
|
|
4831
|
+
**is_active:** `Internal::Types::Boolean`
|
|
4970
4832
|
|
|
4971
4833
|
</dd>
|
|
4972
4834
|
</dl>
|
|
@@ -4974,7 +4836,7 @@ client.partners.groups_create(
|
|
|
4974
4836
|
<dl>
|
|
4975
4837
|
<dd>
|
|
4976
4838
|
|
|
4977
|
-
**
|
|
4839
|
+
**legal_country_class:** `Nordlet::Partners::Types::UpdatePartnersRequestLegalCountryClass`
|
|
4978
4840
|
|
|
4979
4841
|
</dd>
|
|
4980
4842
|
</dl>
|
|
@@ -4994,7 +4856,7 @@ client.partners.groups_create(
|
|
|
4994
4856
|
</dl>
|
|
4995
4857
|
</details>
|
|
4996
4858
|
|
|
4997
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
4859
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">delete</a>(request) -> Nordlet::Partners::Types::DeletePartnersResponse</code></summary>
|
|
4998
4860
|
<dl>
|
|
4999
4861
|
<dd>
|
|
5000
4862
|
|
|
@@ -5006,7 +4868,7 @@ client.partners.groups_create(
|
|
|
5006
4868
|
<dl>
|
|
5007
4869
|
<dd>
|
|
5008
4870
|
|
|
5009
|
-
|
|
4871
|
+
Marks a partner as deleted; it no longer appears in lists or lookups.
|
|
5010
4872
|
</dd>
|
|
5011
4873
|
</dl>
|
|
5012
4874
|
</dd>
|
|
@@ -5021,7 +4883,7 @@ Changes the code or name of a partner group; a code already used by another grou
|
|
|
5021
4883
|
<dd>
|
|
5022
4884
|
|
|
5023
4885
|
```ruby
|
|
5024
|
-
client.partners.
|
|
4886
|
+
client.partners.delete(id: "id")
|
|
5025
4887
|
```
|
|
5026
4888
|
</dd>
|
|
5027
4889
|
</dl>
|
|
@@ -5044,22 +4906,6 @@ client.partners.groups_update(id: "id")
|
|
|
5044
4906
|
<dl>
|
|
5045
4907
|
<dd>
|
|
5046
4908
|
|
|
5047
|
-
**code:** `String`
|
|
5048
|
-
|
|
5049
|
-
</dd>
|
|
5050
|
-
</dl>
|
|
5051
|
-
|
|
5052
|
-
<dl>
|
|
5053
|
-
<dd>
|
|
5054
|
-
|
|
5055
|
-
**name:** `String`
|
|
5056
|
-
|
|
5057
|
-
</dd>
|
|
5058
|
-
</dl>
|
|
5059
|
-
|
|
5060
|
-
<dl>
|
|
5061
|
-
<dd>
|
|
5062
|
-
|
|
5063
4909
|
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
5064
4910
|
|
|
5065
4911
|
</dd>
|
|
@@ -5072,7 +4918,7 @@ client.partners.groups_update(id: "id")
|
|
|
5072
4918
|
</dl>
|
|
5073
4919
|
</details>
|
|
5074
4920
|
|
|
5075
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
4921
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">merge</a>(request) -> Nordlet::Partners::Types::MergePartnersResponse</code></summary>
|
|
5076
4922
|
<dl>
|
|
5077
4923
|
<dd>
|
|
5078
4924
|
|
|
@@ -5084,7 +4930,7 @@ client.partners.groups_update(id: "id")
|
|
|
5084
4930
|
<dl>
|
|
5085
4931
|
<dd>
|
|
5086
4932
|
|
|
5087
|
-
|
|
4933
|
+
Moves every row that references the duplicate `sourceId` through a foreign key to partners (looked up in the database catalogue, within the company) to `targetId`, then marks the source partner as deleted; `moved` lists the tables, columns and row counts. Merging a partner into itself is 422, and when both partners hold the same unique entry (for example the same IBAN or item supplier row) the merge is refused with 409 until it is removed from one of them. When the kept partner has an open VAT review, the duplicate's open review is resolved as `superseded` (`vat_review.resolved`).
|
|
5088
4934
|
</dd>
|
|
5089
4935
|
</dl>
|
|
5090
4936
|
</dd>
|
|
@@ -5099,7 +4945,10 @@ Deletes a partner group; a group still assigned to a live partner is refused wit
|
|
|
5099
4945
|
<dd>
|
|
5100
4946
|
|
|
5101
4947
|
```ruby
|
|
5102
|
-
client.partners.
|
|
4948
|
+
client.partners.merge(
|
|
4949
|
+
source_id: "sourceId",
|
|
4950
|
+
target_id: "targetId"
|
|
4951
|
+
)
|
|
5103
4952
|
```
|
|
5104
4953
|
</dd>
|
|
5105
4954
|
</dl>
|
|
@@ -5114,7 +4963,15 @@ client.partners.groups_delete(id: "id")
|
|
|
5114
4963
|
<dl>
|
|
5115
4964
|
<dd>
|
|
5116
4965
|
|
|
5117
|
-
**
|
|
4966
|
+
**source_id:** `String`
|
|
4967
|
+
|
|
4968
|
+
</dd>
|
|
4969
|
+
</dl>
|
|
4970
|
+
|
|
4971
|
+
<dl>
|
|
4972
|
+
<dd>
|
|
4973
|
+
|
|
4974
|
+
**target_id:** `String`
|
|
5118
4975
|
|
|
5119
4976
|
</dd>
|
|
5120
4977
|
</dl>
|
|
@@ -5134,7 +4991,7 @@ client.partners.groups_delete(id: "id")
|
|
|
5134
4991
|
</dl>
|
|
5135
4992
|
</details>
|
|
5136
4993
|
|
|
5137
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
4994
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">anonymize</a>(request) -> Nordlet::Partners::Types::AnonymizePartnersResponse</code></summary>
|
|
5138
4995
|
<dl>
|
|
5139
4996
|
<dd>
|
|
5140
4997
|
|
|
@@ -5146,7 +5003,7 @@ client.partners.groups_delete(id: "id")
|
|
|
5146
5003
|
<dl>
|
|
5147
5004
|
<dd>
|
|
5148
5005
|
|
|
5149
|
-
|
|
5006
|
+
Removes birth date, self-employment certificate number, email, phone, address, notes, contacts, addresses and bank accounts, then hides the partner. The name, code and VAT number stay because issued invoices must keep identifying the counterparty for the statutory retention period.
|
|
5150
5007
|
</dd>
|
|
5151
5008
|
</dl>
|
|
5152
5009
|
</dd>
|
|
@@ -5161,7 +5018,7 @@ Lists the company's partner groups ordered by code.
|
|
|
5161
5018
|
<dd>
|
|
5162
5019
|
|
|
5163
5020
|
```ruby
|
|
5164
|
-
client.partners.
|
|
5021
|
+
client.partners.anonymize(id: "id")
|
|
5165
5022
|
```
|
|
5166
5023
|
</dd>
|
|
5167
5024
|
</dl>
|
|
@@ -5176,6 +5033,14 @@ client.partners.groups_list
|
|
|
5176
5033
|
<dl>
|
|
5177
5034
|
<dd>
|
|
5178
5035
|
|
|
5036
|
+
**id:** `String`
|
|
5037
|
+
|
|
5038
|
+
</dd>
|
|
5039
|
+
</dl>
|
|
5040
|
+
|
|
5041
|
+
<dl>
|
|
5042
|
+
<dd>
|
|
5043
|
+
|
|
5179
5044
|
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
5180
5045
|
|
|
5181
5046
|
</dd>
|
|
@@ -5188,7 +5053,7 @@ client.partners.groups_list
|
|
|
5188
5053
|
</dl>
|
|
5189
5054
|
</details>
|
|
5190
5055
|
|
|
5191
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
5056
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">list</a>(request) -> Nordlet::Partners::Types::ListPartnersResponse</code></summary>
|
|
5192
5057
|
<dl>
|
|
5193
5058
|
<dd>
|
|
5194
5059
|
|
|
@@ -5200,7 +5065,7 @@ client.partners.groups_list
|
|
|
5200
5065
|
<dl>
|
|
5201
5066
|
<dd>
|
|
5202
5067
|
|
|
5203
|
-
|
|
5068
|
+
Lists live partners; filterable by `name`, `code`, `vatCode`, `email`, `type`, `isCustomer`, `isSupplier`, `isActive`, `legalCountryClass`, `isEmployee`, `groupId`, `statusId` and `nextCallDate`, sortable by `name`, `code`, `createdAt`, `nextCallDate` and `rating`.
|
|
5204
5069
|
</dd>
|
|
5205
5070
|
</dl>
|
|
5206
5071
|
</dd>
|
|
@@ -5215,10 +5080,7 @@ Creates a partner status with a `sortOrder`; a `code` already used by a status o
|
|
|
5215
5080
|
<dd>
|
|
5216
5081
|
|
|
5217
5082
|
```ruby
|
|
5218
|
-
client.partners.
|
|
5219
|
-
code: "code",
|
|
5220
|
-
name: "name"
|
|
5221
|
-
)
|
|
5083
|
+
client.partners.list
|
|
5222
5084
|
```
|
|
5223
5085
|
</dd>
|
|
5224
5086
|
</dl>
|
|
@@ -5233,7 +5095,7 @@ client.partners.statuses_create(
|
|
|
5233
5095
|
<dl>
|
|
5234
5096
|
<dd>
|
|
5235
5097
|
|
|
5236
|
-
**
|
|
5098
|
+
**page:** `Integer`
|
|
5237
5099
|
|
|
5238
5100
|
</dd>
|
|
5239
5101
|
</dl>
|
|
@@ -5241,7 +5103,7 @@ client.partners.statuses_create(
|
|
|
5241
5103
|
<dl>
|
|
5242
5104
|
<dd>
|
|
5243
5105
|
|
|
5244
|
-
**
|
|
5106
|
+
**page_size:** `Integer`
|
|
5245
5107
|
|
|
5246
5108
|
</dd>
|
|
5247
5109
|
</dl>
|
|
@@ -5249,7 +5111,23 @@ client.partners.statuses_create(
|
|
|
5249
5111
|
<dl>
|
|
5250
5112
|
<dd>
|
|
5251
5113
|
|
|
5252
|
-
**
|
|
5114
|
+
**sort:** `Internal::Types::Array[Nordlet::Partners::Types::ListPartnersRequestSortItem]`
|
|
5115
|
+
|
|
5116
|
+
</dd>
|
|
5117
|
+
</dl>
|
|
5118
|
+
|
|
5119
|
+
<dl>
|
|
5120
|
+
<dd>
|
|
5121
|
+
|
|
5122
|
+
**filter:** `Internal::Types::Array[Nordlet::Partners::Types::ListPartnersRequestFilterItem]`
|
|
5123
|
+
|
|
5124
|
+
</dd>
|
|
5125
|
+
</dl>
|
|
5126
|
+
|
|
5127
|
+
<dl>
|
|
5128
|
+
<dd>
|
|
5129
|
+
|
|
5130
|
+
**totals:** `Internal::Types::Array[String]` — Numeric fields to sum over every row matching the filter (not only the current page)
|
|
5253
5131
|
|
|
5254
5132
|
</dd>
|
|
5255
5133
|
</dl>
|
|
@@ -5269,7 +5147,7 @@ client.partners.statuses_create(
|
|
|
5269
5147
|
</dl>
|
|
5270
5148
|
</details>
|
|
5271
5149
|
|
|
5272
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
5150
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">groups_create</a>(request) -> Nordlet::Partners::Types::GroupsCreatePartnersResponse</code></summary>
|
|
5273
5151
|
<dl>
|
|
5274
5152
|
<dd>
|
|
5275
5153
|
|
|
@@ -5281,7 +5159,7 @@ client.partners.statuses_create(
|
|
|
5281
5159
|
<dl>
|
|
5282
5160
|
<dd>
|
|
5283
5161
|
|
|
5284
|
-
|
|
5162
|
+
Creates a partner group; a `code` already used by a group of the company is refused with 409.
|
|
5285
5163
|
</dd>
|
|
5286
5164
|
</dl>
|
|
5287
5165
|
</dd>
|
|
@@ -5296,7 +5174,10 @@ Changes the code, name or sort order of a partner status; a code already used by
|
|
|
5296
5174
|
<dd>
|
|
5297
5175
|
|
|
5298
5176
|
```ruby
|
|
5299
|
-
client.partners.
|
|
5177
|
+
client.partners.groups_create(
|
|
5178
|
+
code: "code",
|
|
5179
|
+
name: "name"
|
|
5180
|
+
)
|
|
5300
5181
|
```
|
|
5301
5182
|
</dd>
|
|
5302
5183
|
</dl>
|
|
@@ -5311,14 +5192,6 @@ client.partners.statuses_update(id: "id")
|
|
|
5311
5192
|
<dl>
|
|
5312
5193
|
<dd>
|
|
5313
5194
|
|
|
5314
|
-
**id:** `String`
|
|
5315
|
-
|
|
5316
|
-
</dd>
|
|
5317
|
-
</dl>
|
|
5318
|
-
|
|
5319
|
-
<dl>
|
|
5320
|
-
<dd>
|
|
5321
|
-
|
|
5322
5195
|
**code:** `String`
|
|
5323
5196
|
|
|
5324
5197
|
</dd>
|
|
@@ -5335,14 +5208,6 @@ client.partners.statuses_update(id: "id")
|
|
|
5335
5208
|
<dl>
|
|
5336
5209
|
<dd>
|
|
5337
5210
|
|
|
5338
|
-
**sort_order:** `Integer`
|
|
5339
|
-
|
|
5340
|
-
</dd>
|
|
5341
|
-
</dl>
|
|
5342
|
-
|
|
5343
|
-
<dl>
|
|
5344
|
-
<dd>
|
|
5345
|
-
|
|
5346
5211
|
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
5347
5212
|
|
|
5348
5213
|
</dd>
|
|
@@ -5355,7 +5220,7 @@ client.partners.statuses_update(id: "id")
|
|
|
5355
5220
|
</dl>
|
|
5356
5221
|
</details>
|
|
5357
5222
|
|
|
5358
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
5223
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">groups_update</a>(request) -> Nordlet::Partners::Types::GroupsUpdatePartnersResponse</code></summary>
|
|
5359
5224
|
<dl>
|
|
5360
5225
|
<dd>
|
|
5361
5226
|
|
|
@@ -5367,7 +5232,7 @@ client.partners.statuses_update(id: "id")
|
|
|
5367
5232
|
<dl>
|
|
5368
5233
|
<dd>
|
|
5369
5234
|
|
|
5370
|
-
|
|
5235
|
+
Changes the code or name of a partner group; a code already used by another group of the company is refused with 409.
|
|
5371
5236
|
</dd>
|
|
5372
5237
|
</dl>
|
|
5373
5238
|
</dd>
|
|
@@ -5382,7 +5247,7 @@ Deletes a partner status; a status still assigned to a live partner is refused w
|
|
|
5382
5247
|
<dd>
|
|
5383
5248
|
|
|
5384
5249
|
```ruby
|
|
5385
|
-
client.partners.
|
|
5250
|
+
client.partners.groups_update(id: "id")
|
|
5386
5251
|
```
|
|
5387
5252
|
</dd>
|
|
5388
5253
|
</dl>
|
|
@@ -5405,57 +5270,19 @@ client.partners.statuses_delete(id: "id")
|
|
|
5405
5270
|
<dl>
|
|
5406
5271
|
<dd>
|
|
5407
5272
|
|
|
5408
|
-
**
|
|
5273
|
+
**code:** `String`
|
|
5409
5274
|
|
|
5410
5275
|
</dd>
|
|
5411
5276
|
</dl>
|
|
5412
|
-
</dd>
|
|
5413
|
-
</dl>
|
|
5414
|
-
|
|
5415
|
-
|
|
5416
|
-
</dd>
|
|
5417
|
-
</dl>
|
|
5418
|
-
</details>
|
|
5419
|
-
|
|
5420
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">statuses_list</a>(request) -> Nordlet::Partners::Types::StatusesListPartnersResponse</code></summary>
|
|
5421
|
-
<dl>
|
|
5422
|
-
<dd>
|
|
5423
|
-
|
|
5424
|
-
#### 📝 Description
|
|
5425
|
-
|
|
5426
|
-
<dl>
|
|
5427
|
-
<dd>
|
|
5428
|
-
|
|
5429
|
-
<dl>
|
|
5430
|
-
<dd>
|
|
5431
|
-
|
|
5432
|
-
Lists the company's partner statuses ordered by sort order, then code.
|
|
5433
|
-
</dd>
|
|
5434
|
-
</dl>
|
|
5435
|
-
</dd>
|
|
5436
|
-
</dl>
|
|
5437
|
-
|
|
5438
|
-
#### 🔌 Usage
|
|
5439
5277
|
|
|
5440
5278
|
<dl>
|
|
5441
5279
|
<dd>
|
|
5442
5280
|
|
|
5443
|
-
|
|
5444
|
-
|
|
5445
|
-
|
|
5446
|
-
```ruby
|
|
5447
|
-
client.partners.statuses_list
|
|
5448
|
-
```
|
|
5449
|
-
</dd>
|
|
5450
|
-
</dl>
|
|
5281
|
+
**name:** `String`
|
|
5282
|
+
|
|
5451
5283
|
</dd>
|
|
5452
5284
|
</dl>
|
|
5453
5285
|
|
|
5454
|
-
#### ⚙️ Parameters
|
|
5455
|
-
|
|
5456
|
-
<dl>
|
|
5457
|
-
<dd>
|
|
5458
|
-
|
|
5459
5286
|
<dl>
|
|
5460
5287
|
<dd>
|
|
5461
5288
|
|
|
@@ -5471,7 +5298,7 @@ client.partners.statuses_list
|
|
|
5471
5298
|
</dl>
|
|
5472
5299
|
</details>
|
|
5473
5300
|
|
|
5474
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
5301
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">groups_delete</a>(request) -> Nordlet::Partners::Types::GroupsDeletePartnersResponse</code></summary>
|
|
5475
5302
|
<dl>
|
|
5476
5303
|
<dd>
|
|
5477
5304
|
|
|
@@ -5483,7 +5310,7 @@ client.partners.statuses_list
|
|
|
5483
5310
|
<dl>
|
|
5484
5311
|
<dd>
|
|
5485
5312
|
|
|
5486
|
-
|
|
5313
|
+
Deletes a partner group; a group still assigned to a live partner is refused with 409.
|
|
5487
5314
|
</dd>
|
|
5488
5315
|
</dl>
|
|
5489
5316
|
</dd>
|
|
@@ -5498,7 +5325,7 @@ Records an inquiry in status `new`, from a partner (`partnerId`) or from a conta
|
|
|
5498
5325
|
<dd>
|
|
5499
5326
|
|
|
5500
5327
|
```ruby
|
|
5501
|
-
client.partners.
|
|
5328
|
+
client.partners.groups_delete(id: "id")
|
|
5502
5329
|
```
|
|
5503
5330
|
</dd>
|
|
5504
5331
|
</dl>
|
|
@@ -5513,7 +5340,7 @@ client.partners.inquiries_create(subject: "subject")
|
|
|
5513
5340
|
<dl>
|
|
5514
5341
|
<dd>
|
|
5515
5342
|
|
|
5516
|
-
**
|
|
5343
|
+
**id:** `String`
|
|
5517
5344
|
|
|
5518
5345
|
</dd>
|
|
5519
5346
|
</dl>
|
|
@@ -5521,67 +5348,57 @@ client.partners.inquiries_create(subject: "subject")
|
|
|
5521
5348
|
<dl>
|
|
5522
5349
|
<dd>
|
|
5523
5350
|
|
|
5524
|
-
**
|
|
5351
|
+
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
5525
5352
|
|
|
5526
5353
|
</dd>
|
|
5527
5354
|
</dl>
|
|
5355
|
+
</dd>
|
|
5356
|
+
</dl>
|
|
5528
5357
|
|
|
5529
|
-
<dl>
|
|
5530
|
-
<dd>
|
|
5531
5358
|
|
|
5532
|
-
**contact_email:** `String`
|
|
5533
|
-
|
|
5534
5359
|
</dd>
|
|
5535
5360
|
</dl>
|
|
5361
|
+
</details>
|
|
5536
5362
|
|
|
5363
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">groups_list</a>(request) -> Nordlet::Partners::Types::GroupsListPartnersResponse</code></summary>
|
|
5537
5364
|
<dl>
|
|
5538
5365
|
<dd>
|
|
5539
5366
|
|
|
5540
|
-
|
|
5541
|
-
|
|
5542
|
-
</dd>
|
|
5543
|
-
</dl>
|
|
5367
|
+
#### 📝 Description
|
|
5544
5368
|
|
|
5545
5369
|
<dl>
|
|
5546
5370
|
<dd>
|
|
5547
5371
|
|
|
5548
|
-
**subject:** `String`
|
|
5549
|
-
|
|
5550
|
-
</dd>
|
|
5551
|
-
</dl>
|
|
5552
|
-
|
|
5553
5372
|
<dl>
|
|
5554
5373
|
<dd>
|
|
5555
5374
|
|
|
5556
|
-
|
|
5557
|
-
|
|
5375
|
+
Lists the company's partner groups ordered by code.
|
|
5376
|
+
</dd>
|
|
5377
|
+
</dl>
|
|
5558
5378
|
</dd>
|
|
5559
5379
|
</dl>
|
|
5560
5380
|
|
|
5381
|
+
#### 🔌 Usage
|
|
5382
|
+
|
|
5561
5383
|
<dl>
|
|
5562
5384
|
<dd>
|
|
5563
5385
|
|
|
5564
|
-
**channel:** `String`
|
|
5565
|
-
|
|
5566
|
-
</dd>
|
|
5567
|
-
</dl>
|
|
5568
|
-
|
|
5569
5386
|
<dl>
|
|
5570
5387
|
<dd>
|
|
5571
5388
|
|
|
5572
|
-
|
|
5573
|
-
|
|
5389
|
+
```ruby
|
|
5390
|
+
client.partners.groups_list
|
|
5391
|
+
```
|
|
5392
|
+
</dd>
|
|
5393
|
+
</dl>
|
|
5574
5394
|
</dd>
|
|
5575
5395
|
</dl>
|
|
5576
5396
|
|
|
5397
|
+
#### ⚙️ Parameters
|
|
5398
|
+
|
|
5577
5399
|
<dl>
|
|
5578
5400
|
<dd>
|
|
5579
5401
|
|
|
5580
|
-
**notes:** `String`
|
|
5581
|
-
|
|
5582
|
-
</dd>
|
|
5583
|
-
</dl>
|
|
5584
|
-
|
|
5585
5402
|
<dl>
|
|
5586
5403
|
<dd>
|
|
5587
5404
|
|
|
@@ -5597,7 +5414,7 @@ client.partners.inquiries_create(subject: "subject")
|
|
|
5597
5414
|
</dl>
|
|
5598
5415
|
</details>
|
|
5599
5416
|
|
|
5600
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
5417
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">statuses_create</a>(request) -> Nordlet::Partners::Types::StatusesCreatePartnersResponse</code></summary>
|
|
5601
5418
|
<dl>
|
|
5602
5419
|
<dd>
|
|
5603
5420
|
|
|
@@ -5609,7 +5426,7 @@ client.partners.inquiries_create(subject: "subject")
|
|
|
5609
5426
|
<dl>
|
|
5610
5427
|
<dd>
|
|
5611
5428
|
|
|
5612
|
-
|
|
5429
|
+
Creates a partner status with a `sortOrder`; a `code` already used by a status of the company is refused with 409.
|
|
5613
5430
|
</dd>
|
|
5614
5431
|
</dl>
|
|
5615
5432
|
</dd>
|
|
@@ -5624,7 +5441,10 @@ Changes the given fields of an inquiry; `partnerId` and `assignedUserId` accept
|
|
|
5624
5441
|
<dd>
|
|
5625
5442
|
|
|
5626
5443
|
```ruby
|
|
5627
|
-
client.partners.
|
|
5444
|
+
client.partners.statuses_create(
|
|
5445
|
+
code: "code",
|
|
5446
|
+
name: "name"
|
|
5447
|
+
)
|
|
5628
5448
|
```
|
|
5629
5449
|
</dd>
|
|
5630
5450
|
</dl>
|
|
@@ -5639,47 +5459,7 @@ client.partners.inquiries_update(id: "id")
|
|
|
5639
5459
|
<dl>
|
|
5640
5460
|
<dd>
|
|
5641
5461
|
|
|
5642
|
-
**
|
|
5643
|
-
|
|
5644
|
-
</dd>
|
|
5645
|
-
</dl>
|
|
5646
|
-
|
|
5647
|
-
<dl>
|
|
5648
|
-
<dd>
|
|
5649
|
-
|
|
5650
|
-
**partner_id:** `String`
|
|
5651
|
-
|
|
5652
|
-
</dd>
|
|
5653
|
-
</dl>
|
|
5654
|
-
|
|
5655
|
-
<dl>
|
|
5656
|
-
<dd>
|
|
5657
|
-
|
|
5658
|
-
**subject:** `String`
|
|
5659
|
-
|
|
5660
|
-
</dd>
|
|
5661
|
-
</dl>
|
|
5662
|
-
|
|
5663
|
-
<dl>
|
|
5664
|
-
<dd>
|
|
5665
|
-
|
|
5666
|
-
**body:** `String`
|
|
5667
|
-
|
|
5668
|
-
</dd>
|
|
5669
|
-
</dl>
|
|
5670
|
-
|
|
5671
|
-
<dl>
|
|
5672
|
-
<dd>
|
|
5673
|
-
|
|
5674
|
-
**channel:** `String`
|
|
5675
|
-
|
|
5676
|
-
</dd>
|
|
5677
|
-
</dl>
|
|
5678
|
-
|
|
5679
|
-
<dl>
|
|
5680
|
-
<dd>
|
|
5681
|
-
|
|
5682
|
-
**status:** `Nordlet::Partners::Types::InquiriesUpdatePartnersRequestStatus`
|
|
5462
|
+
**code:** `String`
|
|
5683
5463
|
|
|
5684
5464
|
</dd>
|
|
5685
5465
|
</dl>
|
|
@@ -5687,7 +5467,7 @@ client.partners.inquiries_update(id: "id")
|
|
|
5687
5467
|
<dl>
|
|
5688
5468
|
<dd>
|
|
5689
5469
|
|
|
5690
|
-
**
|
|
5470
|
+
**name:** `String`
|
|
5691
5471
|
|
|
5692
5472
|
</dd>
|
|
5693
5473
|
</dl>
|
|
@@ -5695,7 +5475,7 @@ client.partners.inquiries_update(id: "id")
|
|
|
5695
5475
|
<dl>
|
|
5696
5476
|
<dd>
|
|
5697
5477
|
|
|
5698
|
-
**
|
|
5478
|
+
**sort_order:** `Integer`
|
|
5699
5479
|
|
|
5700
5480
|
</dd>
|
|
5701
5481
|
</dl>
|
|
@@ -5715,7 +5495,7 @@ client.partners.inquiries_update(id: "id")
|
|
|
5715
5495
|
</dl>
|
|
5716
5496
|
</details>
|
|
5717
5497
|
|
|
5718
|
-
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">
|
|
5498
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">statuses_update</a>(request) -> Nordlet::Partners::Types::StatusesUpdatePartnersResponse</code></summary>
|
|
5719
5499
|
<dl>
|
|
5720
5500
|
<dd>
|
|
5721
5501
|
|
|
@@ -5727,7 +5507,7 @@ client.partners.inquiries_update(id: "id")
|
|
|
5727
5507
|
<dl>
|
|
5728
5508
|
<dd>
|
|
5729
5509
|
|
|
5730
|
-
|
|
5510
|
+
Changes the code, name or sort order of a partner status; a code already used by another status of the company is refused with 409.
|
|
5731
5511
|
</dd>
|
|
5732
5512
|
</dl>
|
|
5733
5513
|
</dd>
|
|
@@ -5742,7 +5522,453 @@ Returns one inquiry with the name of its partner.
|
|
|
5742
5522
|
<dd>
|
|
5743
5523
|
|
|
5744
5524
|
```ruby
|
|
5745
|
-
client.partners.
|
|
5525
|
+
client.partners.statuses_update(id: "id")
|
|
5526
|
+
```
|
|
5527
|
+
</dd>
|
|
5528
|
+
</dl>
|
|
5529
|
+
</dd>
|
|
5530
|
+
</dl>
|
|
5531
|
+
|
|
5532
|
+
#### ⚙️ Parameters
|
|
5533
|
+
|
|
5534
|
+
<dl>
|
|
5535
|
+
<dd>
|
|
5536
|
+
|
|
5537
|
+
<dl>
|
|
5538
|
+
<dd>
|
|
5539
|
+
|
|
5540
|
+
**id:** `String`
|
|
5541
|
+
|
|
5542
|
+
</dd>
|
|
5543
|
+
</dl>
|
|
5544
|
+
|
|
5545
|
+
<dl>
|
|
5546
|
+
<dd>
|
|
5547
|
+
|
|
5548
|
+
**code:** `String`
|
|
5549
|
+
|
|
5550
|
+
</dd>
|
|
5551
|
+
</dl>
|
|
5552
|
+
|
|
5553
|
+
<dl>
|
|
5554
|
+
<dd>
|
|
5555
|
+
|
|
5556
|
+
**name:** `String`
|
|
5557
|
+
|
|
5558
|
+
</dd>
|
|
5559
|
+
</dl>
|
|
5560
|
+
|
|
5561
|
+
<dl>
|
|
5562
|
+
<dd>
|
|
5563
|
+
|
|
5564
|
+
**sort_order:** `Integer`
|
|
5565
|
+
|
|
5566
|
+
</dd>
|
|
5567
|
+
</dl>
|
|
5568
|
+
|
|
5569
|
+
<dl>
|
|
5570
|
+
<dd>
|
|
5571
|
+
|
|
5572
|
+
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
5573
|
+
|
|
5574
|
+
</dd>
|
|
5575
|
+
</dl>
|
|
5576
|
+
</dd>
|
|
5577
|
+
</dl>
|
|
5578
|
+
|
|
5579
|
+
|
|
5580
|
+
</dd>
|
|
5581
|
+
</dl>
|
|
5582
|
+
</details>
|
|
5583
|
+
|
|
5584
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">statuses_delete</a>(request) -> Nordlet::Partners::Types::StatusesDeletePartnersResponse</code></summary>
|
|
5585
|
+
<dl>
|
|
5586
|
+
<dd>
|
|
5587
|
+
|
|
5588
|
+
#### 📝 Description
|
|
5589
|
+
|
|
5590
|
+
<dl>
|
|
5591
|
+
<dd>
|
|
5592
|
+
|
|
5593
|
+
<dl>
|
|
5594
|
+
<dd>
|
|
5595
|
+
|
|
5596
|
+
Deletes a partner status; a status still assigned to a live partner is refused with 409.
|
|
5597
|
+
</dd>
|
|
5598
|
+
</dl>
|
|
5599
|
+
</dd>
|
|
5600
|
+
</dl>
|
|
5601
|
+
|
|
5602
|
+
#### 🔌 Usage
|
|
5603
|
+
|
|
5604
|
+
<dl>
|
|
5605
|
+
<dd>
|
|
5606
|
+
|
|
5607
|
+
<dl>
|
|
5608
|
+
<dd>
|
|
5609
|
+
|
|
5610
|
+
```ruby
|
|
5611
|
+
client.partners.statuses_delete(id: "id")
|
|
5612
|
+
```
|
|
5613
|
+
</dd>
|
|
5614
|
+
</dl>
|
|
5615
|
+
</dd>
|
|
5616
|
+
</dl>
|
|
5617
|
+
|
|
5618
|
+
#### ⚙️ Parameters
|
|
5619
|
+
|
|
5620
|
+
<dl>
|
|
5621
|
+
<dd>
|
|
5622
|
+
|
|
5623
|
+
<dl>
|
|
5624
|
+
<dd>
|
|
5625
|
+
|
|
5626
|
+
**id:** `String`
|
|
5627
|
+
|
|
5628
|
+
</dd>
|
|
5629
|
+
</dl>
|
|
5630
|
+
|
|
5631
|
+
<dl>
|
|
5632
|
+
<dd>
|
|
5633
|
+
|
|
5634
|
+
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
5635
|
+
|
|
5636
|
+
</dd>
|
|
5637
|
+
</dl>
|
|
5638
|
+
</dd>
|
|
5639
|
+
</dl>
|
|
5640
|
+
|
|
5641
|
+
|
|
5642
|
+
</dd>
|
|
5643
|
+
</dl>
|
|
5644
|
+
</details>
|
|
5645
|
+
|
|
5646
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">statuses_list</a>(request) -> Nordlet::Partners::Types::StatusesListPartnersResponse</code></summary>
|
|
5647
|
+
<dl>
|
|
5648
|
+
<dd>
|
|
5649
|
+
|
|
5650
|
+
#### 📝 Description
|
|
5651
|
+
|
|
5652
|
+
<dl>
|
|
5653
|
+
<dd>
|
|
5654
|
+
|
|
5655
|
+
<dl>
|
|
5656
|
+
<dd>
|
|
5657
|
+
|
|
5658
|
+
Lists the company's partner statuses ordered by sort order, then code.
|
|
5659
|
+
</dd>
|
|
5660
|
+
</dl>
|
|
5661
|
+
</dd>
|
|
5662
|
+
</dl>
|
|
5663
|
+
|
|
5664
|
+
#### 🔌 Usage
|
|
5665
|
+
|
|
5666
|
+
<dl>
|
|
5667
|
+
<dd>
|
|
5668
|
+
|
|
5669
|
+
<dl>
|
|
5670
|
+
<dd>
|
|
5671
|
+
|
|
5672
|
+
```ruby
|
|
5673
|
+
client.partners.statuses_list
|
|
5674
|
+
```
|
|
5675
|
+
</dd>
|
|
5676
|
+
</dl>
|
|
5677
|
+
</dd>
|
|
5678
|
+
</dl>
|
|
5679
|
+
|
|
5680
|
+
#### ⚙️ Parameters
|
|
5681
|
+
|
|
5682
|
+
<dl>
|
|
5683
|
+
<dd>
|
|
5684
|
+
|
|
5685
|
+
<dl>
|
|
5686
|
+
<dd>
|
|
5687
|
+
|
|
5688
|
+
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
5689
|
+
|
|
5690
|
+
</dd>
|
|
5691
|
+
</dl>
|
|
5692
|
+
</dd>
|
|
5693
|
+
</dl>
|
|
5694
|
+
|
|
5695
|
+
|
|
5696
|
+
</dd>
|
|
5697
|
+
</dl>
|
|
5698
|
+
</details>
|
|
5699
|
+
|
|
5700
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">inquiries_create</a>(request) -> Nordlet::Partners::Types::InquiriesCreatePartnersResponse</code></summary>
|
|
5701
|
+
<dl>
|
|
5702
|
+
<dd>
|
|
5703
|
+
|
|
5704
|
+
#### 📝 Description
|
|
5705
|
+
|
|
5706
|
+
<dl>
|
|
5707
|
+
<dd>
|
|
5708
|
+
|
|
5709
|
+
<dl>
|
|
5710
|
+
<dd>
|
|
5711
|
+
|
|
5712
|
+
Records an inquiry in status `new`, from a partner (`partnerId`) or from a contact given by `contactName` or `contactEmail`; without any of the three it is refused with 422. `assignedUserId` must be a member of the company. Emits `partner_inquiry.created`.
|
|
5713
|
+
</dd>
|
|
5714
|
+
</dl>
|
|
5715
|
+
</dd>
|
|
5716
|
+
</dl>
|
|
5717
|
+
|
|
5718
|
+
#### 🔌 Usage
|
|
5719
|
+
|
|
5720
|
+
<dl>
|
|
5721
|
+
<dd>
|
|
5722
|
+
|
|
5723
|
+
<dl>
|
|
5724
|
+
<dd>
|
|
5725
|
+
|
|
5726
|
+
```ruby
|
|
5727
|
+
client.partners.inquiries_create(subject: "subject")
|
|
5728
|
+
```
|
|
5729
|
+
</dd>
|
|
5730
|
+
</dl>
|
|
5731
|
+
</dd>
|
|
5732
|
+
</dl>
|
|
5733
|
+
|
|
5734
|
+
#### ⚙️ Parameters
|
|
5735
|
+
|
|
5736
|
+
<dl>
|
|
5737
|
+
<dd>
|
|
5738
|
+
|
|
5739
|
+
<dl>
|
|
5740
|
+
<dd>
|
|
5741
|
+
|
|
5742
|
+
**partner_id:** `String`
|
|
5743
|
+
|
|
5744
|
+
</dd>
|
|
5745
|
+
</dl>
|
|
5746
|
+
|
|
5747
|
+
<dl>
|
|
5748
|
+
<dd>
|
|
5749
|
+
|
|
5750
|
+
**contact_name:** `String`
|
|
5751
|
+
|
|
5752
|
+
</dd>
|
|
5753
|
+
</dl>
|
|
5754
|
+
|
|
5755
|
+
<dl>
|
|
5756
|
+
<dd>
|
|
5757
|
+
|
|
5758
|
+
**contact_email:** `String`
|
|
5759
|
+
|
|
5760
|
+
</dd>
|
|
5761
|
+
</dl>
|
|
5762
|
+
|
|
5763
|
+
<dl>
|
|
5764
|
+
<dd>
|
|
5765
|
+
|
|
5766
|
+
**contact_phone:** `String`
|
|
5767
|
+
|
|
5768
|
+
</dd>
|
|
5769
|
+
</dl>
|
|
5770
|
+
|
|
5771
|
+
<dl>
|
|
5772
|
+
<dd>
|
|
5773
|
+
|
|
5774
|
+
**subject:** `String`
|
|
5775
|
+
|
|
5776
|
+
</dd>
|
|
5777
|
+
</dl>
|
|
5778
|
+
|
|
5779
|
+
<dl>
|
|
5780
|
+
<dd>
|
|
5781
|
+
|
|
5782
|
+
**body:** `String`
|
|
5783
|
+
|
|
5784
|
+
</dd>
|
|
5785
|
+
</dl>
|
|
5786
|
+
|
|
5787
|
+
<dl>
|
|
5788
|
+
<dd>
|
|
5789
|
+
|
|
5790
|
+
**channel:** `String`
|
|
5791
|
+
|
|
5792
|
+
</dd>
|
|
5793
|
+
</dl>
|
|
5794
|
+
|
|
5795
|
+
<dl>
|
|
5796
|
+
<dd>
|
|
5797
|
+
|
|
5798
|
+
**assigned_user_id:** `String`
|
|
5799
|
+
|
|
5800
|
+
</dd>
|
|
5801
|
+
</dl>
|
|
5802
|
+
|
|
5803
|
+
<dl>
|
|
5804
|
+
<dd>
|
|
5805
|
+
|
|
5806
|
+
**notes:** `String`
|
|
5807
|
+
|
|
5808
|
+
</dd>
|
|
5809
|
+
</dl>
|
|
5810
|
+
|
|
5811
|
+
<dl>
|
|
5812
|
+
<dd>
|
|
5813
|
+
|
|
5814
|
+
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
5815
|
+
|
|
5816
|
+
</dd>
|
|
5817
|
+
</dl>
|
|
5818
|
+
</dd>
|
|
5819
|
+
</dl>
|
|
5820
|
+
|
|
5821
|
+
|
|
5822
|
+
</dd>
|
|
5823
|
+
</dl>
|
|
5824
|
+
</details>
|
|
5825
|
+
|
|
5826
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">inquiries_update</a>(request) -> Nordlet::Partners::Types::InquiriesUpdatePartnersResponse</code></summary>
|
|
5827
|
+
<dl>
|
|
5828
|
+
<dd>
|
|
5829
|
+
|
|
5830
|
+
#### 📝 Description
|
|
5831
|
+
|
|
5832
|
+
<dl>
|
|
5833
|
+
<dd>
|
|
5834
|
+
|
|
5835
|
+
<dl>
|
|
5836
|
+
<dd>
|
|
5837
|
+
|
|
5838
|
+
Changes the given fields of an inquiry; `partnerId` and `assignedUserId` accept null. Setting `status` to `closed` stamps `closedAt`, and moving a closed inquiry to another status clears it.
|
|
5839
|
+
</dd>
|
|
5840
|
+
</dl>
|
|
5841
|
+
</dd>
|
|
5842
|
+
</dl>
|
|
5843
|
+
|
|
5844
|
+
#### 🔌 Usage
|
|
5845
|
+
|
|
5846
|
+
<dl>
|
|
5847
|
+
<dd>
|
|
5848
|
+
|
|
5849
|
+
<dl>
|
|
5850
|
+
<dd>
|
|
5851
|
+
|
|
5852
|
+
```ruby
|
|
5853
|
+
client.partners.inquiries_update(id: "id")
|
|
5854
|
+
```
|
|
5855
|
+
</dd>
|
|
5856
|
+
</dl>
|
|
5857
|
+
</dd>
|
|
5858
|
+
</dl>
|
|
5859
|
+
|
|
5860
|
+
#### ⚙️ Parameters
|
|
5861
|
+
|
|
5862
|
+
<dl>
|
|
5863
|
+
<dd>
|
|
5864
|
+
|
|
5865
|
+
<dl>
|
|
5866
|
+
<dd>
|
|
5867
|
+
|
|
5868
|
+
**id:** `String`
|
|
5869
|
+
|
|
5870
|
+
</dd>
|
|
5871
|
+
</dl>
|
|
5872
|
+
|
|
5873
|
+
<dl>
|
|
5874
|
+
<dd>
|
|
5875
|
+
|
|
5876
|
+
**partner_id:** `String`
|
|
5877
|
+
|
|
5878
|
+
</dd>
|
|
5879
|
+
</dl>
|
|
5880
|
+
|
|
5881
|
+
<dl>
|
|
5882
|
+
<dd>
|
|
5883
|
+
|
|
5884
|
+
**subject:** `String`
|
|
5885
|
+
|
|
5886
|
+
</dd>
|
|
5887
|
+
</dl>
|
|
5888
|
+
|
|
5889
|
+
<dl>
|
|
5890
|
+
<dd>
|
|
5891
|
+
|
|
5892
|
+
**body:** `String`
|
|
5893
|
+
|
|
5894
|
+
</dd>
|
|
5895
|
+
</dl>
|
|
5896
|
+
|
|
5897
|
+
<dl>
|
|
5898
|
+
<dd>
|
|
5899
|
+
|
|
5900
|
+
**channel:** `String`
|
|
5901
|
+
|
|
5902
|
+
</dd>
|
|
5903
|
+
</dl>
|
|
5904
|
+
|
|
5905
|
+
<dl>
|
|
5906
|
+
<dd>
|
|
5907
|
+
|
|
5908
|
+
**status:** `Nordlet::Partners::Types::InquiriesUpdatePartnersRequestStatus`
|
|
5909
|
+
|
|
5910
|
+
</dd>
|
|
5911
|
+
</dl>
|
|
5912
|
+
|
|
5913
|
+
<dl>
|
|
5914
|
+
<dd>
|
|
5915
|
+
|
|
5916
|
+
**assigned_user_id:** `String`
|
|
5917
|
+
|
|
5918
|
+
</dd>
|
|
5919
|
+
</dl>
|
|
5920
|
+
|
|
5921
|
+
<dl>
|
|
5922
|
+
<dd>
|
|
5923
|
+
|
|
5924
|
+
**notes:** `String`
|
|
5925
|
+
|
|
5926
|
+
</dd>
|
|
5927
|
+
</dl>
|
|
5928
|
+
|
|
5929
|
+
<dl>
|
|
5930
|
+
<dd>
|
|
5931
|
+
|
|
5932
|
+
**request_options:** `Nordlet::Partners::RequestOptions`
|
|
5933
|
+
|
|
5934
|
+
</dd>
|
|
5935
|
+
</dl>
|
|
5936
|
+
</dd>
|
|
5937
|
+
</dl>
|
|
5938
|
+
|
|
5939
|
+
|
|
5940
|
+
</dd>
|
|
5941
|
+
</dl>
|
|
5942
|
+
</details>
|
|
5943
|
+
|
|
5944
|
+
<details><summary><code>client.partners.<a href="/lib/nordlet/partners/client.rb">inquiries_get</a>(request) -> Nordlet::Partners::Types::InquiriesGetPartnersResponse</code></summary>
|
|
5945
|
+
<dl>
|
|
5946
|
+
<dd>
|
|
5947
|
+
|
|
5948
|
+
#### 📝 Description
|
|
5949
|
+
|
|
5950
|
+
<dl>
|
|
5951
|
+
<dd>
|
|
5952
|
+
|
|
5953
|
+
<dl>
|
|
5954
|
+
<dd>
|
|
5955
|
+
|
|
5956
|
+
Returns one inquiry with the name of its partner.
|
|
5957
|
+
</dd>
|
|
5958
|
+
</dl>
|
|
5959
|
+
</dd>
|
|
5960
|
+
</dl>
|
|
5961
|
+
|
|
5962
|
+
#### 🔌 Usage
|
|
5963
|
+
|
|
5964
|
+
<dl>
|
|
5965
|
+
<dd>
|
|
5966
|
+
|
|
5967
|
+
<dl>
|
|
5968
|
+
<dd>
|
|
5969
|
+
|
|
5970
|
+
```ruby
|
|
5971
|
+
client.partners.inquiries_get(id: "id")
|
|
5746
5972
|
```
|
|
5747
5973
|
</dd>
|
|
5748
5974
|
</dl>
|
|
@@ -10480,6 +10706,22 @@ client.sales.invoices_create(
|
|
|
10480
10706
|
<dl>
|
|
10481
10707
|
<dd>
|
|
10482
10708
|
|
|
10709
|
+
**pay_link_enabled:** `Internal::Types::Boolean` — Whether the PDF and the e-mail carry the payment link of the company payment link template
|
|
10710
|
+
|
|
10711
|
+
</dd>
|
|
10712
|
+
</dl>
|
|
10713
|
+
|
|
10714
|
+
<dl>
|
|
10715
|
+
<dd>
|
|
10716
|
+
|
|
10717
|
+
**debt_reminders_enabled:** `Internal::Types::Boolean` — Whether automatic debt reminders include this invoice when its partner has them turned on
|
|
10718
|
+
|
|
10719
|
+
</dd>
|
|
10720
|
+
</dl>
|
|
10721
|
+
|
|
10722
|
+
<dl>
|
|
10723
|
+
<dd>
|
|
10724
|
+
|
|
10483
10725
|
**operation_type_id:** `String`
|
|
10484
10726
|
|
|
10485
10727
|
</dd>
|
|
@@ -10552,6 +10794,14 @@ client.sales.invoices_create(
|
|
|
10552
10794
|
<dl>
|
|
10553
10795
|
<dd>
|
|
10554
10796
|
|
|
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
|
+
|
|
10799
|
+
</dd>
|
|
10800
|
+
</dl>
|
|
10801
|
+
|
|
10802
|
+
<dl>
|
|
10803
|
+
<dd>
|
|
10804
|
+
|
|
10555
10805
|
**lines:** `Internal::Types::Array[Nordlet::Sales::Types::InvoicesCreateSalesRequestLinesItem]`
|
|
10556
10806
|
|
|
10557
10807
|
</dd>
|
|
@@ -10700,6 +10950,68 @@ client.sales.invoices_pdf(id: "id")
|
|
|
10700
10950
|
</dl>
|
|
10701
10951
|
|
|
10702
10952
|
|
|
10953
|
+
</dd>
|
|
10954
|
+
</dl>
|
|
10955
|
+
</details>
|
|
10956
|
+
|
|
10957
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoices_view</a>(request) -> Nordlet::Sales::Types::InvoicesViewSalesResponse</code></summary>
|
|
10958
|
+
<dl>
|
|
10959
|
+
<dd>
|
|
10960
|
+
|
|
10961
|
+
#### 📝 Description
|
|
10962
|
+
|
|
10963
|
+
<dl>
|
|
10964
|
+
<dd>
|
|
10965
|
+
|
|
10966
|
+
<dl>
|
|
10967
|
+
<dd>
|
|
10968
|
+
|
|
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.
|
|
10970
|
+
</dd>
|
|
10971
|
+
</dl>
|
|
10972
|
+
</dd>
|
|
10973
|
+
</dl>
|
|
10974
|
+
|
|
10975
|
+
#### 🔌 Usage
|
|
10976
|
+
|
|
10977
|
+
<dl>
|
|
10978
|
+
<dd>
|
|
10979
|
+
|
|
10980
|
+
<dl>
|
|
10981
|
+
<dd>
|
|
10982
|
+
|
|
10983
|
+
```ruby
|
|
10984
|
+
client.sales.invoices_view(id: "id")
|
|
10985
|
+
```
|
|
10986
|
+
</dd>
|
|
10987
|
+
</dl>
|
|
10988
|
+
</dd>
|
|
10989
|
+
</dl>
|
|
10990
|
+
|
|
10991
|
+
#### ⚙️ Parameters
|
|
10992
|
+
|
|
10993
|
+
<dl>
|
|
10994
|
+
<dd>
|
|
10995
|
+
|
|
10996
|
+
<dl>
|
|
10997
|
+
<dd>
|
|
10998
|
+
|
|
10999
|
+
**id:** `String`
|
|
11000
|
+
|
|
11001
|
+
</dd>
|
|
11002
|
+
</dl>
|
|
11003
|
+
|
|
11004
|
+
<dl>
|
|
11005
|
+
<dd>
|
|
11006
|
+
|
|
11007
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
11008
|
+
|
|
11009
|
+
</dd>
|
|
11010
|
+
</dl>
|
|
11011
|
+
</dd>
|
|
11012
|
+
</dl>
|
|
11013
|
+
|
|
11014
|
+
|
|
10703
11015
|
</dd>
|
|
10704
11016
|
</dl>
|
|
10705
11017
|
</details>
|
|
@@ -10716,7 +11028,7 @@ client.sales.invoices_pdf(id: "id")
|
|
|
10716
11028
|
<dl>
|
|
10717
11029
|
<dd>
|
|
10718
11030
|
|
|
10719
|
-
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`. Answers 422 when e-mail sending is not configured, when the document is not issued, or when neither `to` nor the partner's e-mail is set.
|
|
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.
|
|
10720
11032
|
</dd>
|
|
10721
11033
|
</dl>
|
|
10722
11034
|
</dd>
|
|
@@ -10770,6 +11082,14 @@ client.sales.invoices_send(id: "id")
|
|
|
10770
11082
|
<dl>
|
|
10771
11083
|
<dd>
|
|
10772
11084
|
|
|
11085
|
+
**quote:** `Internal::Types::Boolean`
|
|
11086
|
+
|
|
11087
|
+
</dd>
|
|
11088
|
+
</dl>
|
|
11089
|
+
|
|
11090
|
+
<dl>
|
|
11091
|
+
<dd>
|
|
11092
|
+
|
|
10773
11093
|
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
10774
11094
|
|
|
10775
11095
|
</dd>
|
|
@@ -11166,7 +11486,7 @@ client.sales.invoices_einvoice_status(id: "id")
|
|
|
11166
11486
|
<dl>
|
|
11167
11487
|
<dd>
|
|
11168
11488
|
|
|
11169
|
-
Change a draft sale document. Fields left out keep their value, `lines` replaces every line,
|
|
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).
|
|
11170
11490
|
</dd>
|
|
11171
11491
|
</dl>
|
|
11172
11492
|
</dd>
|
|
@@ -11316,6 +11636,22 @@ client.sales.invoices_update(id: "id")
|
|
|
11316
11636
|
<dl>
|
|
11317
11637
|
<dd>
|
|
11318
11638
|
|
|
11639
|
+
**pay_link_enabled:** `Internal::Types::Boolean`
|
|
11640
|
+
|
|
11641
|
+
</dd>
|
|
11642
|
+
</dl>
|
|
11643
|
+
|
|
11644
|
+
<dl>
|
|
11645
|
+
<dd>
|
|
11646
|
+
|
|
11647
|
+
**debt_reminders_enabled:** `Internal::Types::Boolean`
|
|
11648
|
+
|
|
11649
|
+
</dd>
|
|
11650
|
+
</dl>
|
|
11651
|
+
|
|
11652
|
+
<dl>
|
|
11653
|
+
<dd>
|
|
11654
|
+
|
|
11319
11655
|
**operation_type_id:** `String`
|
|
11320
11656
|
|
|
11321
11657
|
</dd>
|
|
@@ -11388,6 +11724,14 @@ client.sales.invoices_update(id: "id")
|
|
|
11388
11724
|
<dl>
|
|
11389
11725
|
<dd>
|
|
11390
11726
|
|
|
11727
|
+
**sales_tax_percent:** `String`
|
|
11728
|
+
|
|
11729
|
+
</dd>
|
|
11730
|
+
</dl>
|
|
11731
|
+
|
|
11732
|
+
<dl>
|
|
11733
|
+
<dd>
|
|
11734
|
+
|
|
11391
11735
|
**lines:** `Internal::Types::Array[Nordlet::Sales::Types::InvoicesUpdateSalesRequestLinesItem]`
|
|
11392
11736
|
|
|
11393
11737
|
</dd>
|
|
@@ -11700,7 +12044,7 @@ client.sales.invoices_unlock(id: "id")
|
|
|
11700
12044
|
<dl>
|
|
11701
12045
|
<dd>
|
|
11702
12046
|
|
|
11703
|
-
Return the customer payment link of a sale document, rendered from the company's payment link template (`sales/invoices/payment-settings/update`); `url` is null when the company has
|
|
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.
|
|
11704
12048
|
</dd>
|
|
11705
12049
|
</dl>
|
|
11706
12050
|
</dd>
|
|
@@ -13081,87 +13425,315 @@ client.sales.invoice_templates_update(id: "id")
|
|
|
13081
13425
|
<dl>
|
|
13082
13426
|
<dd>
|
|
13083
13427
|
|
|
13084
|
-
**name:** `String`
|
|
13428
|
+
**name:** `String`
|
|
13429
|
+
|
|
13430
|
+
</dd>
|
|
13431
|
+
</dl>
|
|
13432
|
+
|
|
13433
|
+
<dl>
|
|
13434
|
+
<dd>
|
|
13435
|
+
|
|
13436
|
+
**document_type:** `Nordlet::Sales::Types::InvoiceTemplatesUpdateSalesRequestDocumentType`
|
|
13437
|
+
|
|
13438
|
+
</dd>
|
|
13439
|
+
</dl>
|
|
13440
|
+
|
|
13441
|
+
<dl>
|
|
13442
|
+
<dd>
|
|
13443
|
+
|
|
13444
|
+
**partner_id:** `String`
|
|
13445
|
+
|
|
13446
|
+
</dd>
|
|
13447
|
+
</dl>
|
|
13448
|
+
|
|
13449
|
+
<dl>
|
|
13450
|
+
<dd>
|
|
13451
|
+
|
|
13452
|
+
**currency:** `String`
|
|
13453
|
+
|
|
13454
|
+
</dd>
|
|
13455
|
+
</dl>
|
|
13456
|
+
|
|
13457
|
+
<dl>
|
|
13458
|
+
<dd>
|
|
13459
|
+
|
|
13460
|
+
**payment_term_days:** `Integer`
|
|
13461
|
+
|
|
13462
|
+
</dd>
|
|
13463
|
+
</dl>
|
|
13464
|
+
|
|
13465
|
+
<dl>
|
|
13466
|
+
<dd>
|
|
13467
|
+
|
|
13468
|
+
**vat_scheme:** `Nordlet::Sales::Types::InvoiceTemplatesUpdateSalesRequestVatScheme`
|
|
13469
|
+
|
|
13470
|
+
</dd>
|
|
13471
|
+
</dl>
|
|
13472
|
+
|
|
13473
|
+
<dl>
|
|
13474
|
+
<dd>
|
|
13475
|
+
|
|
13476
|
+
**vat_country_code:** `String`
|
|
13477
|
+
|
|
13478
|
+
</dd>
|
|
13479
|
+
</dl>
|
|
13480
|
+
|
|
13481
|
+
<dl>
|
|
13482
|
+
<dd>
|
|
13483
|
+
|
|
13484
|
+
**agreement_id:** `String`
|
|
13485
|
+
|
|
13486
|
+
</dd>
|
|
13487
|
+
</dl>
|
|
13488
|
+
|
|
13489
|
+
<dl>
|
|
13490
|
+
<dd>
|
|
13491
|
+
|
|
13492
|
+
**operation_type_id:** `String`
|
|
13493
|
+
|
|
13494
|
+
</dd>
|
|
13495
|
+
</dl>
|
|
13496
|
+
|
|
13497
|
+
<dl>
|
|
13498
|
+
<dd>
|
|
13499
|
+
|
|
13500
|
+
**document_series_id:** `String`
|
|
13501
|
+
|
|
13502
|
+
</dd>
|
|
13503
|
+
</dl>
|
|
13504
|
+
|
|
13505
|
+
<dl>
|
|
13506
|
+
<dd>
|
|
13507
|
+
|
|
13508
|
+
**discount_percent:** `String`
|
|
13509
|
+
|
|
13510
|
+
</dd>
|
|
13511
|
+
</dl>
|
|
13512
|
+
|
|
13513
|
+
<dl>
|
|
13514
|
+
<dd>
|
|
13515
|
+
|
|
13516
|
+
**issued_by_name:** `String`
|
|
13517
|
+
|
|
13518
|
+
</dd>
|
|
13519
|
+
</dl>
|
|
13520
|
+
|
|
13521
|
+
<dl>
|
|
13522
|
+
<dd>
|
|
13523
|
+
|
|
13524
|
+
**issued_by_title:** `String`
|
|
13525
|
+
|
|
13526
|
+
</dd>
|
|
13527
|
+
</dl>
|
|
13528
|
+
|
|
13529
|
+
<dl>
|
|
13530
|
+
<dd>
|
|
13531
|
+
|
|
13532
|
+
**received_by_name:** `String`
|
|
13533
|
+
|
|
13534
|
+
</dd>
|
|
13535
|
+
</dl>
|
|
13536
|
+
|
|
13537
|
+
<dl>
|
|
13538
|
+
<dd>
|
|
13539
|
+
|
|
13540
|
+
**received_by_title:** `String`
|
|
13541
|
+
|
|
13542
|
+
</dd>
|
|
13543
|
+
</dl>
|
|
13544
|
+
|
|
13545
|
+
<dl>
|
|
13546
|
+
<dd>
|
|
13547
|
+
|
|
13548
|
+
**notes:** `String`
|
|
13549
|
+
|
|
13550
|
+
</dd>
|
|
13551
|
+
</dl>
|
|
13552
|
+
|
|
13553
|
+
<dl>
|
|
13554
|
+
<dd>
|
|
13555
|
+
|
|
13556
|
+
**supply_type:** `Nordlet::Sales::Types::InvoiceTemplatesUpdateSalesRequestSupplyType`
|
|
13557
|
+
|
|
13558
|
+
</dd>
|
|
13559
|
+
</dl>
|
|
13560
|
+
|
|
13561
|
+
<dl>
|
|
13562
|
+
<dd>
|
|
13563
|
+
|
|
13564
|
+
**series_label:** `String`
|
|
13565
|
+
|
|
13566
|
+
</dd>
|
|
13567
|
+
</dl>
|
|
13568
|
+
|
|
13569
|
+
<dl>
|
|
13570
|
+
<dd>
|
|
13571
|
+
|
|
13572
|
+
**order_number:** `String`
|
|
13573
|
+
|
|
13574
|
+
</dd>
|
|
13575
|
+
</dl>
|
|
13576
|
+
|
|
13577
|
+
<dl>
|
|
13578
|
+
<dd>
|
|
13579
|
+
|
|
13580
|
+
**intrastat_transport_mode:** `String`
|
|
13581
|
+
|
|
13582
|
+
</dd>
|
|
13583
|
+
</dl>
|
|
13584
|
+
|
|
13585
|
+
<dl>
|
|
13586
|
+
<dd>
|
|
13587
|
+
|
|
13588
|
+
**intrastat_delivery_terms:** `String`
|
|
13589
|
+
|
|
13590
|
+
</dd>
|
|
13591
|
+
</dl>
|
|
13592
|
+
|
|
13593
|
+
<dl>
|
|
13594
|
+
<dd>
|
|
13595
|
+
|
|
13596
|
+
**intrastat_region:** `String`
|
|
13597
|
+
|
|
13598
|
+
</dd>
|
|
13599
|
+
</dl>
|
|
13600
|
+
|
|
13601
|
+
<dl>
|
|
13602
|
+
<dd>
|
|
13603
|
+
|
|
13604
|
+
**intrastat_nature_of_transaction:** `String`
|
|
13605
|
+
|
|
13606
|
+
</dd>
|
|
13607
|
+
</dl>
|
|
13608
|
+
|
|
13609
|
+
<dl>
|
|
13610
|
+
<dd>
|
|
13611
|
+
|
|
13612
|
+
**lines:** `Internal::Types::Array[Nordlet::Sales::Types::InvoiceTemplatesUpdateSalesRequestLinesItem]`
|
|
13613
|
+
|
|
13614
|
+
</dd>
|
|
13615
|
+
</dl>
|
|
13616
|
+
|
|
13617
|
+
<dl>
|
|
13618
|
+
<dd>
|
|
13619
|
+
|
|
13620
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
13621
|
+
|
|
13622
|
+
</dd>
|
|
13623
|
+
</dl>
|
|
13624
|
+
</dd>
|
|
13625
|
+
</dl>
|
|
13626
|
+
|
|
13627
|
+
|
|
13628
|
+
</dd>
|
|
13629
|
+
</dl>
|
|
13630
|
+
</details>
|
|
13631
|
+
|
|
13632
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoice_templates_get</a>(request) -> Nordlet::Sales::Types::InvoiceTemplatesGetSalesResponse</code></summary>
|
|
13633
|
+
<dl>
|
|
13634
|
+
<dd>
|
|
13635
|
+
|
|
13636
|
+
#### 📝 Description
|
|
13637
|
+
|
|
13638
|
+
<dl>
|
|
13639
|
+
<dd>
|
|
13640
|
+
|
|
13641
|
+
<dl>
|
|
13642
|
+
<dd>
|
|
13643
|
+
|
|
13644
|
+
Return one invoice template.
|
|
13645
|
+
</dd>
|
|
13646
|
+
</dl>
|
|
13647
|
+
</dd>
|
|
13648
|
+
</dl>
|
|
13649
|
+
|
|
13650
|
+
#### 🔌 Usage
|
|
13651
|
+
|
|
13652
|
+
<dl>
|
|
13653
|
+
<dd>
|
|
13654
|
+
|
|
13655
|
+
<dl>
|
|
13656
|
+
<dd>
|
|
13657
|
+
|
|
13658
|
+
```ruby
|
|
13659
|
+
client.sales.invoice_templates_get(id: "id")
|
|
13660
|
+
```
|
|
13661
|
+
</dd>
|
|
13662
|
+
</dl>
|
|
13663
|
+
</dd>
|
|
13664
|
+
</dl>
|
|
13665
|
+
|
|
13666
|
+
#### ⚙️ Parameters
|
|
13667
|
+
|
|
13668
|
+
<dl>
|
|
13669
|
+
<dd>
|
|
13670
|
+
|
|
13671
|
+
<dl>
|
|
13672
|
+
<dd>
|
|
13673
|
+
|
|
13674
|
+
**id:** `String`
|
|
13675
|
+
|
|
13676
|
+
</dd>
|
|
13677
|
+
</dl>
|
|
13678
|
+
|
|
13679
|
+
<dl>
|
|
13680
|
+
<dd>
|
|
13681
|
+
|
|
13682
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
13085
13683
|
|
|
13086
13684
|
</dd>
|
|
13087
13685
|
</dl>
|
|
13088
|
-
|
|
13089
|
-
<dl>
|
|
13090
|
-
<dd>
|
|
13091
|
-
|
|
13092
|
-
**document_type:** `Nordlet::Sales::Types::InvoiceTemplatesUpdateSalesRequestDocumentType`
|
|
13093
|
-
|
|
13094
13686
|
</dd>
|
|
13095
13687
|
</dl>
|
|
13096
13688
|
|
|
13097
|
-
<dl>
|
|
13098
|
-
<dd>
|
|
13099
13689
|
|
|
13100
|
-
**partner_id:** `String`
|
|
13101
|
-
|
|
13102
13690
|
</dd>
|
|
13103
13691
|
</dl>
|
|
13692
|
+
</details>
|
|
13104
13693
|
|
|
13694
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoice_templates_delete</a>(request) -> Nordlet::Sales::Types::InvoiceTemplatesDeleteSalesResponse</code></summary>
|
|
13105
13695
|
<dl>
|
|
13106
13696
|
<dd>
|
|
13107
13697
|
|
|
13108
|
-
|
|
13109
|
-
|
|
13110
|
-
</dd>
|
|
13111
|
-
</dl>
|
|
13698
|
+
#### 📝 Description
|
|
13112
13699
|
|
|
13113
13700
|
<dl>
|
|
13114
13701
|
<dd>
|
|
13115
13702
|
|
|
13116
|
-
**payment_term_days:** `Integer`
|
|
13117
|
-
|
|
13118
|
-
</dd>
|
|
13119
|
-
</dl>
|
|
13120
|
-
|
|
13121
13703
|
<dl>
|
|
13122
13704
|
<dd>
|
|
13123
13705
|
|
|
13124
|
-
|
|
13125
|
-
|
|
13706
|
+
Delete an invoice template.
|
|
13126
13707
|
</dd>
|
|
13127
13708
|
</dl>
|
|
13128
|
-
|
|
13129
|
-
<dl>
|
|
13130
|
-
<dd>
|
|
13131
|
-
|
|
13132
|
-
**vat_country_code:** `String`
|
|
13133
|
-
|
|
13134
13709
|
</dd>
|
|
13135
13710
|
</dl>
|
|
13136
13711
|
|
|
13712
|
+
#### 🔌 Usage
|
|
13713
|
+
|
|
13137
13714
|
<dl>
|
|
13138
13715
|
<dd>
|
|
13139
13716
|
|
|
13140
|
-
**agreement_id:** `String`
|
|
13141
|
-
|
|
13142
|
-
</dd>
|
|
13143
|
-
</dl>
|
|
13144
|
-
|
|
13145
13717
|
<dl>
|
|
13146
13718
|
<dd>
|
|
13147
13719
|
|
|
13148
|
-
|
|
13149
|
-
|
|
13720
|
+
```ruby
|
|
13721
|
+
client.sales.invoice_templates_delete(id: "id")
|
|
13722
|
+
```
|
|
13723
|
+
</dd>
|
|
13724
|
+
</dl>
|
|
13150
13725
|
</dd>
|
|
13151
13726
|
</dl>
|
|
13152
13727
|
|
|
13728
|
+
#### ⚙️ Parameters
|
|
13729
|
+
|
|
13153
13730
|
<dl>
|
|
13154
13731
|
<dd>
|
|
13155
13732
|
|
|
13156
|
-
**document_series_id:** `String`
|
|
13157
|
-
|
|
13158
|
-
</dd>
|
|
13159
|
-
</dl>
|
|
13160
|
-
|
|
13161
13733
|
<dl>
|
|
13162
13734
|
<dd>
|
|
13163
13735
|
|
|
13164
|
-
**
|
|
13736
|
+
**id:** `String`
|
|
13165
13737
|
|
|
13166
13738
|
</dd>
|
|
13167
13739
|
</dl>
|
|
@@ -13169,71 +13741,61 @@ client.sales.invoice_templates_update(id: "id")
|
|
|
13169
13741
|
<dl>
|
|
13170
13742
|
<dd>
|
|
13171
13743
|
|
|
13172
|
-
**
|
|
13744
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
13173
13745
|
|
|
13174
13746
|
</dd>
|
|
13175
13747
|
</dl>
|
|
13748
|
+
</dd>
|
|
13749
|
+
</dl>
|
|
13176
13750
|
|
|
13177
|
-
<dl>
|
|
13178
|
-
<dd>
|
|
13179
13751
|
|
|
13180
|
-
**issued_by_title:** `String`
|
|
13181
|
-
|
|
13182
13752
|
</dd>
|
|
13183
13753
|
</dl>
|
|
13754
|
+
</details>
|
|
13184
13755
|
|
|
13756
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoice_templates_list</a>(request) -> Nordlet::Sales::Types::InvoiceTemplatesListSalesResponse</code></summary>
|
|
13185
13757
|
<dl>
|
|
13186
13758
|
<dd>
|
|
13187
13759
|
|
|
13188
|
-
|
|
13189
|
-
|
|
13190
|
-
</dd>
|
|
13191
|
-
</dl>
|
|
13760
|
+
#### 📝 Description
|
|
13192
13761
|
|
|
13193
13762
|
<dl>
|
|
13194
13763
|
<dd>
|
|
13195
13764
|
|
|
13196
|
-
**received_by_title:** `String`
|
|
13197
|
-
|
|
13198
|
-
</dd>
|
|
13199
|
-
</dl>
|
|
13200
|
-
|
|
13201
13765
|
<dl>
|
|
13202
13766
|
<dd>
|
|
13203
13767
|
|
|
13204
|
-
|
|
13205
|
-
|
|
13768
|
+
List invoice templates. Filterable by name, documentType and partnerId; sortable by name, documentType and createdAt.
|
|
13769
|
+
</dd>
|
|
13770
|
+
</dl>
|
|
13206
13771
|
</dd>
|
|
13207
13772
|
</dl>
|
|
13208
13773
|
|
|
13774
|
+
#### 🔌 Usage
|
|
13775
|
+
|
|
13209
13776
|
<dl>
|
|
13210
13777
|
<dd>
|
|
13211
13778
|
|
|
13212
|
-
**supply_type:** `Nordlet::Sales::Types::InvoiceTemplatesUpdateSalesRequestSupplyType`
|
|
13213
|
-
|
|
13214
|
-
</dd>
|
|
13215
|
-
</dl>
|
|
13216
|
-
|
|
13217
13779
|
<dl>
|
|
13218
13780
|
<dd>
|
|
13219
13781
|
|
|
13220
|
-
|
|
13221
|
-
|
|
13782
|
+
```ruby
|
|
13783
|
+
client.sales.invoice_templates_list
|
|
13784
|
+
```
|
|
13785
|
+
</dd>
|
|
13786
|
+
</dl>
|
|
13222
13787
|
</dd>
|
|
13223
13788
|
</dl>
|
|
13224
13789
|
|
|
13790
|
+
#### ⚙️ Parameters
|
|
13791
|
+
|
|
13225
13792
|
<dl>
|
|
13226
13793
|
<dd>
|
|
13227
13794
|
|
|
13228
|
-
**order_number:** `String`
|
|
13229
|
-
|
|
13230
|
-
</dd>
|
|
13231
|
-
</dl>
|
|
13232
|
-
|
|
13233
13795
|
<dl>
|
|
13234
13796
|
<dd>
|
|
13235
13797
|
|
|
13236
|
-
**
|
|
13798
|
+
**page:** `Integer`
|
|
13237
13799
|
|
|
13238
13800
|
</dd>
|
|
13239
13801
|
</dl>
|
|
@@ -13241,7 +13803,7 @@ client.sales.invoice_templates_update(id: "id")
|
|
|
13241
13803
|
<dl>
|
|
13242
13804
|
<dd>
|
|
13243
13805
|
|
|
13244
|
-
**
|
|
13806
|
+
**page_size:** `Integer`
|
|
13245
13807
|
|
|
13246
13808
|
</dd>
|
|
13247
13809
|
</dl>
|
|
@@ -13249,7 +13811,7 @@ client.sales.invoice_templates_update(id: "id")
|
|
|
13249
13811
|
<dl>
|
|
13250
13812
|
<dd>
|
|
13251
13813
|
|
|
13252
|
-
**
|
|
13814
|
+
**sort:** `Internal::Types::Array[Nordlet::Sales::Types::InvoiceTemplatesListSalesRequestSortItem]`
|
|
13253
13815
|
|
|
13254
13816
|
</dd>
|
|
13255
13817
|
</dl>
|
|
@@ -13257,7 +13819,7 @@ client.sales.invoice_templates_update(id: "id")
|
|
|
13257
13819
|
<dl>
|
|
13258
13820
|
<dd>
|
|
13259
13821
|
|
|
13260
|
-
**
|
|
13822
|
+
**filter:** `Internal::Types::Array[Nordlet::Sales::Types::InvoiceTemplatesListSalesRequestFilterItem]`
|
|
13261
13823
|
|
|
13262
13824
|
</dd>
|
|
13263
13825
|
</dl>
|
|
@@ -13265,7 +13827,7 @@ client.sales.invoice_templates_update(id: "id")
|
|
|
13265
13827
|
<dl>
|
|
13266
13828
|
<dd>
|
|
13267
13829
|
|
|
13268
|
-
**
|
|
13830
|
+
**totals:** `Internal::Types::Array[String]` — Numeric fields to sum over every row matching the filter (not only the current page)
|
|
13269
13831
|
|
|
13270
13832
|
</dd>
|
|
13271
13833
|
</dl>
|
|
@@ -13285,7 +13847,7 @@ client.sales.invoice_templates_update(id: "id")
|
|
|
13285
13847
|
</dl>
|
|
13286
13848
|
</details>
|
|
13287
13849
|
|
|
13288
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
13850
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recurring_invoices_create</a>(request) -> Nordlet::Sales::Types::RecurringInvoicesCreateSalesResponse</code></summary>
|
|
13289
13851
|
<dl>
|
|
13290
13852
|
<dd>
|
|
13291
13853
|
|
|
@@ -13297,7 +13859,7 @@ client.sales.invoice_templates_update(id: "id")
|
|
|
13297
13859
|
<dl>
|
|
13298
13860
|
<dd>
|
|
13299
13861
|
|
|
13300
|
-
|
|
13862
|
+
Create a schedule that generates invoices from an invoice template every `interval` periods of `frequency` from `startDate` (the first run) until `endDate`, for `partnerId` or else the template's partner. `autoIssue` issues each generated invoice and `autoSend` e-mails it to `sendTo`, else to the partner. Invoices are generated by `sales/recurring-invoices/run`, `sales/recurring-invoices/generate` and the scheduled job `recurring-invoices`. Answers 422 when the template is a credit note template, when neither the schedule nor the template names a partner, when `endDate` is before `startDate`, or when `autoSend` is set without `autoIssue`.
|
|
13301
13863
|
</dd>
|
|
13302
13864
|
</dl>
|
|
13303
13865
|
</dd>
|
|
@@ -13312,7 +13874,10 @@ Return one invoice template.
|
|
|
13312
13874
|
<dd>
|
|
13313
13875
|
|
|
13314
13876
|
```ruby
|
|
13315
|
-
client.sales.
|
|
13877
|
+
client.sales.recurring_invoices_create(
|
|
13878
|
+
template_id: "templateId",
|
|
13879
|
+
start_date: "2026-07-01"
|
|
13880
|
+
)
|
|
13316
13881
|
```
|
|
13317
13882
|
</dd>
|
|
13318
13883
|
</dl>
|
|
@@ -13327,7 +13892,7 @@ client.sales.invoice_templates_get(id: "id")
|
|
|
13327
13892
|
<dl>
|
|
13328
13893
|
<dd>
|
|
13329
13894
|
|
|
13330
|
-
**
|
|
13895
|
+
**template_id:** `String`
|
|
13331
13896
|
|
|
13332
13897
|
</dd>
|
|
13333
13898
|
</dl>
|
|
@@ -13335,61 +13900,71 @@ client.sales.invoice_templates_get(id: "id")
|
|
|
13335
13900
|
<dl>
|
|
13336
13901
|
<dd>
|
|
13337
13902
|
|
|
13338
|
-
**
|
|
13903
|
+
**partner_id:** `String`
|
|
13339
13904
|
|
|
13340
13905
|
</dd>
|
|
13341
13906
|
</dl>
|
|
13342
|
-
</dd>
|
|
13343
|
-
</dl>
|
|
13344
13907
|
|
|
13908
|
+
<dl>
|
|
13909
|
+
<dd>
|
|
13345
13910
|
|
|
13911
|
+
**frequency:** `Nordlet::Sales::Types::RecurringInvoicesCreateSalesRequestFrequency`
|
|
13912
|
+
|
|
13346
13913
|
</dd>
|
|
13347
13914
|
</dl>
|
|
13348
|
-
</details>
|
|
13349
13915
|
|
|
13350
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">invoice_templates_delete</a>(request) -> Nordlet::Sales::Types::InvoiceTemplatesDeleteSalesResponse</code></summary>
|
|
13351
13916
|
<dl>
|
|
13352
13917
|
<dd>
|
|
13353
13918
|
|
|
13354
|
-
|
|
13919
|
+
**interval:** `Integer`
|
|
13920
|
+
|
|
13921
|
+
</dd>
|
|
13922
|
+
</dl>
|
|
13355
13923
|
|
|
13356
13924
|
<dl>
|
|
13357
13925
|
<dd>
|
|
13358
13926
|
|
|
13927
|
+
**start_date:** `String`
|
|
13928
|
+
|
|
13929
|
+
</dd>
|
|
13930
|
+
</dl>
|
|
13931
|
+
|
|
13359
13932
|
<dl>
|
|
13360
13933
|
<dd>
|
|
13361
13934
|
|
|
13362
|
-
|
|
13363
|
-
|
|
13364
|
-
</dl>
|
|
13935
|
+
**end_date:** `String`
|
|
13936
|
+
|
|
13365
13937
|
</dd>
|
|
13366
13938
|
</dl>
|
|
13367
13939
|
|
|
13368
|
-
#### 🔌 Usage
|
|
13369
|
-
|
|
13370
13940
|
<dl>
|
|
13371
13941
|
<dd>
|
|
13372
13942
|
|
|
13943
|
+
**locale:** `Nordlet::Sales::Types::RecurringInvoicesCreateSalesRequestLocale`
|
|
13944
|
+
|
|
13945
|
+
</dd>
|
|
13946
|
+
</dl>
|
|
13947
|
+
|
|
13373
13948
|
<dl>
|
|
13374
13949
|
<dd>
|
|
13375
13950
|
|
|
13376
|
-
|
|
13377
|
-
|
|
13378
|
-
```
|
|
13379
|
-
</dd>
|
|
13380
|
-
</dl>
|
|
13951
|
+
**auto_issue:** `Internal::Types::Boolean`
|
|
13952
|
+
|
|
13381
13953
|
</dd>
|
|
13382
13954
|
</dl>
|
|
13383
13955
|
|
|
13384
|
-
#### ⚙️ Parameters
|
|
13385
|
-
|
|
13386
13956
|
<dl>
|
|
13387
13957
|
<dd>
|
|
13388
13958
|
|
|
13959
|
+
**auto_send:** `Internal::Types::Boolean`
|
|
13960
|
+
|
|
13961
|
+
</dd>
|
|
13962
|
+
</dl>
|
|
13963
|
+
|
|
13389
13964
|
<dl>
|
|
13390
13965
|
<dd>
|
|
13391
13966
|
|
|
13392
|
-
**
|
|
13967
|
+
**send_to:** `String`
|
|
13393
13968
|
|
|
13394
13969
|
</dd>
|
|
13395
13970
|
</dl>
|
|
@@ -13409,7 +13984,7 @@ client.sales.invoice_templates_delete(id: "id")
|
|
|
13409
13984
|
</dl>
|
|
13410
13985
|
</details>
|
|
13411
13986
|
|
|
13412
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
13987
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recurring_invoices_update</a>(request) -> Nordlet::Sales::Types::RecurringInvoicesUpdateSalesResponse</code></summary>
|
|
13413
13988
|
<dl>
|
|
13414
13989
|
<dd>
|
|
13415
13990
|
|
|
@@ -13421,7 +13996,7 @@ client.sales.invoice_templates_delete(id: "id")
|
|
|
13421
13996
|
<dl>
|
|
13422
13997
|
<dd>
|
|
13423
13998
|
|
|
13424
|
-
|
|
13999
|
+
Change a schedule; fields left out keep their value. A change of `startDate`, `frequency` or `interval` moves `nextRunDate` to the first occurrence of the new grid on or after the current next run (or the new start date, if later); an explicit `nextRunDate` wins. `status` switches between `active` and `paused`; a next run past `endDate` makes the schedule `finished`. The 422 checks of `sales/recurring-invoices/create` apply.
|
|
13425
14000
|
</dd>
|
|
13426
14001
|
</dl>
|
|
13427
14002
|
</dd>
|
|
@@ -13436,7 +14011,7 @@ List invoice templates. Filterable by name, documentType and partnerId; sortable
|
|
|
13436
14011
|
<dd>
|
|
13437
14012
|
|
|
13438
14013
|
```ruby
|
|
13439
|
-
client.sales.
|
|
14014
|
+
client.sales.recurring_invoices_update(id: "id")
|
|
13440
14015
|
```
|
|
13441
14016
|
</dd>
|
|
13442
14017
|
</dl>
|
|
@@ -13451,7 +14026,7 @@ client.sales.invoice_templates_list
|
|
|
13451
14026
|
<dl>
|
|
13452
14027
|
<dd>
|
|
13453
14028
|
|
|
13454
|
-
**
|
|
14029
|
+
**id:** `String`
|
|
13455
14030
|
|
|
13456
14031
|
</dd>
|
|
13457
14032
|
</dl>
|
|
@@ -13459,7 +14034,7 @@ client.sales.invoice_templates_list
|
|
|
13459
14034
|
<dl>
|
|
13460
14035
|
<dd>
|
|
13461
14036
|
|
|
13462
|
-
**
|
|
14037
|
+
**template_id:** `String`
|
|
13463
14038
|
|
|
13464
14039
|
</dd>
|
|
13465
14040
|
</dl>
|
|
@@ -13467,7 +14042,7 @@ client.sales.invoice_templates_list
|
|
|
13467
14042
|
<dl>
|
|
13468
14043
|
<dd>
|
|
13469
14044
|
|
|
13470
|
-
**
|
|
14045
|
+
**partner_id:** `String`
|
|
13471
14046
|
|
|
13472
14047
|
</dd>
|
|
13473
14048
|
</dl>
|
|
@@ -13475,7 +14050,7 @@ client.sales.invoice_templates_list
|
|
|
13475
14050
|
<dl>
|
|
13476
14051
|
<dd>
|
|
13477
14052
|
|
|
13478
|
-
**
|
|
14053
|
+
**frequency:** `Nordlet::Sales::Types::RecurringInvoicesUpdateSalesRequestFrequency`
|
|
13479
14054
|
|
|
13480
14055
|
</dd>
|
|
13481
14056
|
</dl>
|
|
@@ -13483,7 +14058,7 @@ client.sales.invoice_templates_list
|
|
|
13483
14058
|
<dl>
|
|
13484
14059
|
<dd>
|
|
13485
14060
|
|
|
13486
|
-
**
|
|
14061
|
+
**interval:** `Integer`
|
|
13487
14062
|
|
|
13488
14063
|
</dd>
|
|
13489
14064
|
</dl>
|
|
@@ -13491,64 +14066,39 @@ client.sales.invoice_templates_list
|
|
|
13491
14066
|
<dl>
|
|
13492
14067
|
<dd>
|
|
13493
14068
|
|
|
13494
|
-
**
|
|
14069
|
+
**start_date:** `String`
|
|
13495
14070
|
|
|
13496
14071
|
</dd>
|
|
13497
14072
|
</dl>
|
|
13498
|
-
</dd>
|
|
13499
|
-
</dl>
|
|
13500
14073
|
|
|
13501
|
-
|
|
13502
|
-
</dd>
|
|
13503
|
-
</dl>
|
|
13504
|
-
</details>
|
|
13505
|
-
|
|
13506
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recurring_invoices_create</a>(request) -> Nordlet::Sales::Types::RecurringInvoicesCreateSalesResponse</code></summary>
|
|
13507
14074
|
<dl>
|
|
13508
14075
|
<dd>
|
|
13509
14076
|
|
|
13510
|
-
|
|
13511
|
-
|
|
13512
|
-
|
|
13513
|
-
|
|
14077
|
+
**end_date:** `String`
|
|
14078
|
+
|
|
14079
|
+
</dd>
|
|
14080
|
+
</dl>
|
|
13514
14081
|
|
|
13515
14082
|
<dl>
|
|
13516
14083
|
<dd>
|
|
13517
14084
|
|
|
13518
|
-
|
|
13519
|
-
|
|
13520
|
-
</dl>
|
|
14085
|
+
**next_run_date:** `String`
|
|
14086
|
+
|
|
13521
14087
|
</dd>
|
|
13522
14088
|
</dl>
|
|
13523
14089
|
|
|
13524
|
-
#### 🔌 Usage
|
|
13525
|
-
|
|
13526
|
-
<dl>
|
|
13527
|
-
<dd>
|
|
13528
|
-
|
|
13529
14090
|
<dl>
|
|
13530
14091
|
<dd>
|
|
13531
14092
|
|
|
13532
|
-
|
|
13533
|
-
|
|
13534
|
-
template_id: "templateId",
|
|
13535
|
-
start_date: "2026-07-01"
|
|
13536
|
-
)
|
|
13537
|
-
```
|
|
13538
|
-
</dd>
|
|
13539
|
-
</dl>
|
|
14093
|
+
**status:** `Nordlet::Sales::Types::RecurringInvoicesUpdateSalesRequestStatus`
|
|
14094
|
+
|
|
13540
14095
|
</dd>
|
|
13541
14096
|
</dl>
|
|
13542
14097
|
|
|
13543
|
-
#### ⚙️ Parameters
|
|
13544
|
-
|
|
13545
14098
|
<dl>
|
|
13546
14099
|
<dd>
|
|
13547
14100
|
|
|
13548
|
-
|
|
13549
|
-
<dd>
|
|
13550
|
-
|
|
13551
|
-
**template_id:** `String`
|
|
14101
|
+
**locale:** `Nordlet::Sales::Types::RecurringInvoicesUpdateSalesRequestLocale`
|
|
13552
14102
|
|
|
13553
14103
|
</dd>
|
|
13554
14104
|
</dl>
|
|
@@ -13556,7 +14106,7 @@ client.sales.recurring_invoices_create(
|
|
|
13556
14106
|
<dl>
|
|
13557
14107
|
<dd>
|
|
13558
14108
|
|
|
13559
|
-
**
|
|
14109
|
+
**auto_issue:** `Internal::Types::Boolean`
|
|
13560
14110
|
|
|
13561
14111
|
</dd>
|
|
13562
14112
|
</dl>
|
|
@@ -13564,7 +14114,7 @@ client.sales.recurring_invoices_create(
|
|
|
13564
14114
|
<dl>
|
|
13565
14115
|
<dd>
|
|
13566
14116
|
|
|
13567
|
-
**
|
|
14117
|
+
**auto_send:** `Internal::Types::Boolean`
|
|
13568
14118
|
|
|
13569
14119
|
</dd>
|
|
13570
14120
|
</dl>
|
|
@@ -13572,7 +14122,7 @@ client.sales.recurring_invoices_create(
|
|
|
13572
14122
|
<dl>
|
|
13573
14123
|
<dd>
|
|
13574
14124
|
|
|
13575
|
-
**
|
|
14125
|
+
**send_to:** `String`
|
|
13576
14126
|
|
|
13577
14127
|
</dd>
|
|
13578
14128
|
</dl>
|
|
@@ -13580,47 +14130,61 @@ client.sales.recurring_invoices_create(
|
|
|
13580
14130
|
<dl>
|
|
13581
14131
|
<dd>
|
|
13582
14132
|
|
|
13583
|
-
**
|
|
14133
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
13584
14134
|
|
|
13585
14135
|
</dd>
|
|
13586
14136
|
</dl>
|
|
14137
|
+
</dd>
|
|
14138
|
+
</dl>
|
|
13587
14139
|
|
|
13588
|
-
<dl>
|
|
13589
|
-
<dd>
|
|
13590
14140
|
|
|
13591
|
-
**end_date:** `String`
|
|
13592
|
-
|
|
13593
14141
|
</dd>
|
|
13594
14142
|
</dl>
|
|
14143
|
+
</details>
|
|
13595
14144
|
|
|
14145
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recurring_invoices_get</a>(request) -> Nordlet::Sales::Types::RecurringInvoicesGetSalesResponse</code></summary>
|
|
13596
14146
|
<dl>
|
|
13597
14147
|
<dd>
|
|
13598
14148
|
|
|
13599
|
-
|
|
13600
|
-
|
|
13601
|
-
</dd>
|
|
13602
|
-
</dl>
|
|
14149
|
+
#### 📝 Description
|
|
13603
14150
|
|
|
13604
14151
|
<dl>
|
|
13605
14152
|
<dd>
|
|
13606
14153
|
|
|
13607
|
-
|
|
13608
|
-
|
|
14154
|
+
<dl>
|
|
14155
|
+
<dd>
|
|
14156
|
+
|
|
14157
|
+
Return one recurring invoice schedule with the names of its template and partner.
|
|
14158
|
+
</dd>
|
|
14159
|
+
</dl>
|
|
13609
14160
|
</dd>
|
|
13610
14161
|
</dl>
|
|
13611
14162
|
|
|
14163
|
+
#### 🔌 Usage
|
|
14164
|
+
|
|
13612
14165
|
<dl>
|
|
13613
14166
|
<dd>
|
|
13614
14167
|
|
|
13615
|
-
|
|
13616
|
-
|
|
14168
|
+
<dl>
|
|
14169
|
+
<dd>
|
|
14170
|
+
|
|
14171
|
+
```ruby
|
|
14172
|
+
client.sales.recurring_invoices_get(id: "id")
|
|
14173
|
+
```
|
|
14174
|
+
</dd>
|
|
14175
|
+
</dl>
|
|
13617
14176
|
</dd>
|
|
13618
14177
|
</dl>
|
|
13619
14178
|
|
|
14179
|
+
#### ⚙️ Parameters
|
|
14180
|
+
|
|
13620
14181
|
<dl>
|
|
13621
14182
|
<dd>
|
|
13622
14183
|
|
|
13623
|
-
|
|
14184
|
+
<dl>
|
|
14185
|
+
<dd>
|
|
14186
|
+
|
|
14187
|
+
**id:** `String`
|
|
13624
14188
|
|
|
13625
14189
|
</dd>
|
|
13626
14190
|
</dl>
|
|
@@ -13640,7 +14204,7 @@ client.sales.recurring_invoices_create(
|
|
|
13640
14204
|
</dl>
|
|
13641
14205
|
</details>
|
|
13642
14206
|
|
|
13643
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
14207
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recurring_invoices_delete</a>(request) -> Nordlet::Sales::Types::RecurringInvoicesDeleteSalesResponse</code></summary>
|
|
13644
14208
|
<dl>
|
|
13645
14209
|
<dd>
|
|
13646
14210
|
|
|
@@ -13652,7 +14216,7 @@ client.sales.recurring_invoices_create(
|
|
|
13652
14216
|
<dl>
|
|
13653
14217
|
<dd>
|
|
13654
14218
|
|
|
13655
|
-
|
|
14219
|
+
Delete a recurring invoice schedule. The invoices it generated stay.
|
|
13656
14220
|
</dd>
|
|
13657
14221
|
</dl>
|
|
13658
14222
|
</dd>
|
|
@@ -13667,7 +14231,7 @@ Change a schedule; fields left out keep their value. A change of `startDate`, `f
|
|
|
13667
14231
|
<dd>
|
|
13668
14232
|
|
|
13669
14233
|
```ruby
|
|
13670
|
-
client.sales.
|
|
14234
|
+
client.sales.recurring_invoices_delete(id: "id")
|
|
13671
14235
|
```
|
|
13672
14236
|
</dd>
|
|
13673
14237
|
</dl>
|
|
@@ -13690,31 +14254,61 @@ client.sales.recurring_invoices_update(id: "id")
|
|
|
13690
14254
|
<dl>
|
|
13691
14255
|
<dd>
|
|
13692
14256
|
|
|
13693
|
-
**
|
|
14257
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
13694
14258
|
|
|
13695
14259
|
</dd>
|
|
13696
14260
|
</dl>
|
|
14261
|
+
</dd>
|
|
14262
|
+
</dl>
|
|
14263
|
+
|
|
14264
|
+
|
|
14265
|
+
</dd>
|
|
14266
|
+
</dl>
|
|
14267
|
+
</details>
|
|
14268
|
+
|
|
14269
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recurring_invoices_generate</a>(request) -> Nordlet::Sales::Types::RecurringInvoicesGenerateSalesResponse</code></summary>
|
|
14270
|
+
<dl>
|
|
14271
|
+
<dd>
|
|
14272
|
+
|
|
14273
|
+
#### 📝 Description
|
|
13697
14274
|
|
|
13698
14275
|
<dl>
|
|
13699
14276
|
<dd>
|
|
13700
14277
|
|
|
13701
|
-
|
|
13702
|
-
|
|
14278
|
+
<dl>
|
|
14279
|
+
<dd>
|
|
14280
|
+
|
|
14281
|
+
Generate the next invoice of a schedule now, dated its `nextRunDate`: creates a draft from the template (due date from the template's payment term, VAT scheme from the template or else resolved for the partner and supply type), issues it when `autoIssue` is set and e-mails it when `autoSend` is set, then moves the schedule to its next occurrence (or to `finished` after the last one) and emits `recurring_invoice.generated`. A failure to issue or send comes back in `error` and is stored as `lastError`; the draft stays. Answers 409 when the schedule is finished, 422 when the template is a credit note template or has no lines.
|
|
14282
|
+
</dd>
|
|
14283
|
+
</dl>
|
|
13703
14284
|
</dd>
|
|
13704
14285
|
</dl>
|
|
13705
14286
|
|
|
14287
|
+
#### 🔌 Usage
|
|
14288
|
+
|
|
13706
14289
|
<dl>
|
|
13707
14290
|
<dd>
|
|
13708
14291
|
|
|
13709
|
-
|
|
13710
|
-
|
|
14292
|
+
<dl>
|
|
14293
|
+
<dd>
|
|
14294
|
+
|
|
14295
|
+
```ruby
|
|
14296
|
+
client.sales.recurring_invoices_generate(id: "id")
|
|
14297
|
+
```
|
|
14298
|
+
</dd>
|
|
14299
|
+
</dl>
|
|
13711
14300
|
</dd>
|
|
13712
14301
|
</dl>
|
|
13713
14302
|
|
|
14303
|
+
#### ⚙️ Parameters
|
|
14304
|
+
|
|
13714
14305
|
<dl>
|
|
13715
14306
|
<dd>
|
|
13716
14307
|
|
|
13717
|
-
|
|
14308
|
+
<dl>
|
|
14309
|
+
<dd>
|
|
14310
|
+
|
|
14311
|
+
**id:** `String`
|
|
13718
14312
|
|
|
13719
14313
|
</dd>
|
|
13720
14314
|
</dl>
|
|
@@ -13722,15 +14316,61 @@ client.sales.recurring_invoices_update(id: "id")
|
|
|
13722
14316
|
<dl>
|
|
13723
14317
|
<dd>
|
|
13724
14318
|
|
|
13725
|
-
**
|
|
14319
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
13726
14320
|
|
|
13727
14321
|
</dd>
|
|
13728
14322
|
</dl>
|
|
14323
|
+
</dd>
|
|
14324
|
+
</dl>
|
|
14325
|
+
|
|
14326
|
+
|
|
14327
|
+
</dd>
|
|
14328
|
+
</dl>
|
|
14329
|
+
</details>
|
|
13729
14330
|
|
|
14331
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recurring_invoices_run</a>(request) -> Nordlet::Sales::Types::RecurringInvoicesRunSalesResponse</code></summary>
|
|
13730
14332
|
<dl>
|
|
13731
14333
|
<dd>
|
|
13732
14334
|
|
|
13733
|
-
|
|
14335
|
+
#### 📝 Description
|
|
14336
|
+
|
|
14337
|
+
<dl>
|
|
14338
|
+
<dd>
|
|
14339
|
+
|
|
14340
|
+
<dl>
|
|
14341
|
+
<dd>
|
|
14342
|
+
|
|
14343
|
+
Generate every invoice due up to `asOfDate` (default today) from the active schedules of the company, catching up to 60 missed occurrences per schedule, as `sales/recurring-invoices/generate` does for one; each generated invoice emits `recurring_invoice.generated`. The answer lists what was generated and the schedules that failed; a failure is also stored as the schedule's `lastError`.
|
|
14344
|
+
</dd>
|
|
14345
|
+
</dl>
|
|
14346
|
+
</dd>
|
|
14347
|
+
</dl>
|
|
14348
|
+
|
|
14349
|
+
#### 🔌 Usage
|
|
14350
|
+
|
|
14351
|
+
<dl>
|
|
14352
|
+
<dd>
|
|
14353
|
+
|
|
14354
|
+
<dl>
|
|
14355
|
+
<dd>
|
|
14356
|
+
|
|
14357
|
+
```ruby
|
|
14358
|
+
client.sales.recurring_invoices_run
|
|
14359
|
+
```
|
|
14360
|
+
</dd>
|
|
14361
|
+
</dl>
|
|
14362
|
+
</dd>
|
|
14363
|
+
</dl>
|
|
14364
|
+
|
|
14365
|
+
#### ⚙️ Parameters
|
|
14366
|
+
|
|
14367
|
+
<dl>
|
|
14368
|
+
<dd>
|
|
14369
|
+
|
|
14370
|
+
<dl>
|
|
14371
|
+
<dd>
|
|
14372
|
+
|
|
14373
|
+
**as_of_date:** `String`
|
|
13734
14374
|
|
|
13735
14375
|
</dd>
|
|
13736
14376
|
</dl>
|
|
@@ -13738,15 +14378,61 @@ client.sales.recurring_invoices_update(id: "id")
|
|
|
13738
14378
|
<dl>
|
|
13739
14379
|
<dd>
|
|
13740
14380
|
|
|
13741
|
-
**
|
|
14381
|
+
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
13742
14382
|
|
|
13743
14383
|
</dd>
|
|
13744
14384
|
</dl>
|
|
14385
|
+
</dd>
|
|
14386
|
+
</dl>
|
|
13745
14387
|
|
|
14388
|
+
|
|
14389
|
+
</dd>
|
|
14390
|
+
</dl>
|
|
14391
|
+
</details>
|
|
14392
|
+
|
|
14393
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recurring_invoices_list</a>(request) -> Nordlet::Sales::Types::RecurringInvoicesListSalesResponse</code></summary>
|
|
13746
14394
|
<dl>
|
|
13747
14395
|
<dd>
|
|
13748
14396
|
|
|
13749
|
-
|
|
14397
|
+
#### 📝 Description
|
|
14398
|
+
|
|
14399
|
+
<dl>
|
|
14400
|
+
<dd>
|
|
14401
|
+
|
|
14402
|
+
<dl>
|
|
14403
|
+
<dd>
|
|
14404
|
+
|
|
14405
|
+
List recurring invoice schedules with the names of their template and partner. Filterable by status, partnerId, templateId, frequency, nextRunDate and autoIssue; sortable by nextRunDate, startDate, status, frequency and createdAt.
|
|
14406
|
+
</dd>
|
|
14407
|
+
</dl>
|
|
14408
|
+
</dd>
|
|
14409
|
+
</dl>
|
|
14410
|
+
|
|
14411
|
+
#### 🔌 Usage
|
|
14412
|
+
|
|
14413
|
+
<dl>
|
|
14414
|
+
<dd>
|
|
14415
|
+
|
|
14416
|
+
<dl>
|
|
14417
|
+
<dd>
|
|
14418
|
+
|
|
14419
|
+
```ruby
|
|
14420
|
+
client.sales.recurring_invoices_list
|
|
14421
|
+
```
|
|
14422
|
+
</dd>
|
|
14423
|
+
</dl>
|
|
14424
|
+
</dd>
|
|
14425
|
+
</dl>
|
|
14426
|
+
|
|
14427
|
+
#### ⚙️ Parameters
|
|
14428
|
+
|
|
14429
|
+
<dl>
|
|
14430
|
+
<dd>
|
|
14431
|
+
|
|
14432
|
+
<dl>
|
|
14433
|
+
<dd>
|
|
14434
|
+
|
|
14435
|
+
**page:** `Integer`
|
|
13750
14436
|
|
|
13751
14437
|
</dd>
|
|
13752
14438
|
</dl>
|
|
@@ -13754,7 +14440,7 @@ client.sales.recurring_invoices_update(id: "id")
|
|
|
13754
14440
|
<dl>
|
|
13755
14441
|
<dd>
|
|
13756
14442
|
|
|
13757
|
-
**
|
|
14443
|
+
**page_size:** `Integer`
|
|
13758
14444
|
|
|
13759
14445
|
</dd>
|
|
13760
14446
|
</dl>
|
|
@@ -13762,7 +14448,7 @@ client.sales.recurring_invoices_update(id: "id")
|
|
|
13762
14448
|
<dl>
|
|
13763
14449
|
<dd>
|
|
13764
14450
|
|
|
13765
|
-
**
|
|
14451
|
+
**sort:** `Internal::Types::Array[Nordlet::Sales::Types::RecurringInvoicesListSalesRequestSortItem]`
|
|
13766
14452
|
|
|
13767
14453
|
</dd>
|
|
13768
14454
|
</dl>
|
|
@@ -13770,7 +14456,7 @@ client.sales.recurring_invoices_update(id: "id")
|
|
|
13770
14456
|
<dl>
|
|
13771
14457
|
<dd>
|
|
13772
14458
|
|
|
13773
|
-
**
|
|
14459
|
+
**filter:** `Internal::Types::Array[Nordlet::Sales::Types::RecurringInvoicesListSalesRequestFilterItem]`
|
|
13774
14460
|
|
|
13775
14461
|
</dd>
|
|
13776
14462
|
</dl>
|
|
@@ -13778,7 +14464,7 @@ client.sales.recurring_invoices_update(id: "id")
|
|
|
13778
14464
|
<dl>
|
|
13779
14465
|
<dd>
|
|
13780
14466
|
|
|
13781
|
-
**
|
|
14467
|
+
**totals:** `Internal::Types::Array[String]` — Numeric fields to sum over every row matching the filter (not only the current page)
|
|
13782
14468
|
|
|
13783
14469
|
</dd>
|
|
13784
14470
|
</dl>
|
|
@@ -13798,7 +14484,7 @@ client.sales.recurring_invoices_update(id: "id")
|
|
|
13798
14484
|
</dl>
|
|
13799
14485
|
</details>
|
|
13800
14486
|
|
|
13801
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
14487
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recognition_compute</a>(request) -> Nordlet::Sales::Types::RecognitionComputeSalesResponse</code></summary>
|
|
13802
14488
|
<dl>
|
|
13803
14489
|
<dd>
|
|
13804
14490
|
|
|
@@ -13810,7 +14496,7 @@ client.sales.recurring_invoices_update(id: "id")
|
|
|
13810
14496
|
<dl>
|
|
13811
14497
|
<dd>
|
|
13812
14498
|
|
|
13813
|
-
|
|
14499
|
+
Preview the pending ratable revenue schedules due on or before `asOfDate` (default the company's current date) with their total; nothing is posted. `sales/recognition/run` posts them.
|
|
13814
14500
|
</dd>
|
|
13815
14501
|
</dl>
|
|
13816
14502
|
</dd>
|
|
@@ -13825,7 +14511,7 @@ Return one recurring invoice schedule with the names of its template and partner
|
|
|
13825
14511
|
<dd>
|
|
13826
14512
|
|
|
13827
14513
|
```ruby
|
|
13828
|
-
client.sales.
|
|
14514
|
+
client.sales.recognition_compute
|
|
13829
14515
|
```
|
|
13830
14516
|
</dd>
|
|
13831
14517
|
</dl>
|
|
@@ -13840,7 +14526,7 @@ client.sales.recurring_invoices_get(id: "id")
|
|
|
13840
14526
|
<dl>
|
|
13841
14527
|
<dd>
|
|
13842
14528
|
|
|
13843
|
-
**
|
|
14529
|
+
**as_of_date:** `String`
|
|
13844
14530
|
|
|
13845
14531
|
</dd>
|
|
13846
14532
|
</dl>
|
|
@@ -13860,7 +14546,7 @@ client.sales.recurring_invoices_get(id: "id")
|
|
|
13860
14546
|
</dl>
|
|
13861
14547
|
</details>
|
|
13862
14548
|
|
|
13863
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
14549
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recognition_run</a>(request) -> Nordlet::Sales::Types::RecognitionRunSalesResponse</code></summary>
|
|
13864
14550
|
<dl>
|
|
13865
14551
|
<dd>
|
|
13866
14552
|
|
|
@@ -13872,7 +14558,7 @@ client.sales.recurring_invoices_get(id: "id")
|
|
|
13872
14558
|
<dl>
|
|
13873
14559
|
<dd>
|
|
13874
14560
|
|
|
13875
|
-
|
|
14561
|
+
Recognise deferred revenue: posts one journal entry dated `postingDate` (default `asOfDate`, default the company's current date) that debits the deferred income account and credits each line's revenue account, for the pending ratable schedules due on or before `asOfDate` or for exactly the `scheduleIds` given, marks them recognised, records a run with trigger `manual` and emits `revenue_recognition.posted`. Answers 422 when nothing is due or a given schedule is missing or no longer pending, and 409 when the posting period is locked. Due ratable schedules are also posted by the scheduler once their date has passed (trigger `schedule_due`).
|
|
13876
14562
|
</dd>
|
|
13877
14563
|
</dl>
|
|
13878
14564
|
</dd>
|
|
@@ -13887,7 +14573,7 @@ Delete a recurring invoice schedule. The invoices it generated stay.
|
|
|
13887
14573
|
<dd>
|
|
13888
14574
|
|
|
13889
14575
|
```ruby
|
|
13890
|
-
client.sales.
|
|
14576
|
+
client.sales.recognition_run
|
|
13891
14577
|
```
|
|
13892
14578
|
</dd>
|
|
13893
14579
|
</dl>
|
|
@@ -13902,7 +14588,23 @@ client.sales.recurring_invoices_delete(id: "id")
|
|
|
13902
14588
|
<dl>
|
|
13903
14589
|
<dd>
|
|
13904
14590
|
|
|
13905
|
-
**
|
|
14591
|
+
**as_of_date:** `String`
|
|
14592
|
+
|
|
14593
|
+
</dd>
|
|
14594
|
+
</dl>
|
|
14595
|
+
|
|
14596
|
+
<dl>
|
|
14597
|
+
<dd>
|
|
14598
|
+
|
|
14599
|
+
**posting_date:** `String`
|
|
14600
|
+
|
|
14601
|
+
</dd>
|
|
14602
|
+
</dl>
|
|
14603
|
+
|
|
14604
|
+
<dl>
|
|
14605
|
+
<dd>
|
|
14606
|
+
|
|
14607
|
+
**schedule_ids:** `Internal::Types::Array[String]`
|
|
13906
14608
|
|
|
13907
14609
|
</dd>
|
|
13908
14610
|
</dl>
|
|
@@ -13922,7 +14624,7 @@ client.sales.recurring_invoices_delete(id: "id")
|
|
|
13922
14624
|
</dl>
|
|
13923
14625
|
</details>
|
|
13924
14626
|
|
|
13925
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
14627
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recognition_progress</a>(request) -> Nordlet::Sales::Types::RecognitionProgressSalesResponse</code></summary>
|
|
13926
14628
|
<dl>
|
|
13927
14629
|
<dd>
|
|
13928
14630
|
|
|
@@ -13934,7 +14636,7 @@ client.sales.recurring_invoices_delete(id: "id")
|
|
|
13934
14636
|
<dl>
|
|
13935
14637
|
<dd>
|
|
13936
14638
|
|
|
13937
|
-
|
|
14639
|
+
Report the percentage of completion of a `percent_complete` invoice line and recognise the revenue up to it: a schedule for the difference between the revenue due at that percentage and the amount already recognised is created and posted at once, dated `date` (default the company's current date), as a run with trigger `progress` that emits `revenue_recognition.posted`. Refused with 422 when the line is not `percent_complete`, the invoice is not an issued standard invoice, the percentage is 0 or above 100, or nothing new is to be recognised; 409 when the period is locked.
|
|
13938
14640
|
</dd>
|
|
13939
14641
|
</dl>
|
|
13940
14642
|
</dd>
|
|
@@ -13949,7 +14651,10 @@ Generate the next invoice of a schedule now, dated its `nextRunDate`: creates a
|
|
|
13949
14651
|
<dd>
|
|
13950
14652
|
|
|
13951
14653
|
```ruby
|
|
13952
|
-
client.sales.
|
|
14654
|
+
client.sales.recognition_progress(
|
|
14655
|
+
invoice_line_id: "invoiceLineId",
|
|
14656
|
+
percent_complete: "121.00"
|
|
14657
|
+
)
|
|
13953
14658
|
```
|
|
13954
14659
|
</dd>
|
|
13955
14660
|
</dl>
|
|
@@ -13964,7 +14669,23 @@ client.sales.recurring_invoices_generate(id: "id")
|
|
|
13964
14669
|
<dl>
|
|
13965
14670
|
<dd>
|
|
13966
14671
|
|
|
13967
|
-
**
|
|
14672
|
+
**invoice_line_id:** `String`
|
|
14673
|
+
|
|
14674
|
+
</dd>
|
|
14675
|
+
</dl>
|
|
14676
|
+
|
|
14677
|
+
<dl>
|
|
14678
|
+
<dd>
|
|
14679
|
+
|
|
14680
|
+
**percent_complete:** `String`
|
|
14681
|
+
|
|
14682
|
+
</dd>
|
|
14683
|
+
</dl>
|
|
14684
|
+
|
|
14685
|
+
<dl>
|
|
14686
|
+
<dd>
|
|
14687
|
+
|
|
14688
|
+
**date:** `String`
|
|
13968
14689
|
|
|
13969
14690
|
</dd>
|
|
13970
14691
|
</dl>
|
|
@@ -13984,7 +14705,7 @@ client.sales.recurring_invoices_generate(id: "id")
|
|
|
13984
14705
|
</dl>
|
|
13985
14706
|
</details>
|
|
13986
14707
|
|
|
13987
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
14708
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recognition_modify</a>(request) -> Nordlet::Sales::Types::RecognitionModifySalesResponse</code></summary>
|
|
13988
14709
|
<dl>
|
|
13989
14710
|
<dd>
|
|
13990
14711
|
|
|
@@ -13996,7 +14717,7 @@ client.sales.recurring_invoices_generate(id: "id")
|
|
|
13996
14717
|
<dl>
|
|
13997
14718
|
<dd>
|
|
13998
14719
|
|
|
13999
|
-
|
|
14720
|
+
Apply an IFRS 15 contract modification to a deferred invoice line. Prospective: cancel the pending schedule and respread the unrecognized remainder over the new terms. Cumulative catch-up (ratable only): recompute revenue as if the new terms applied from the start and post the difference immediately.
|
|
14000
14721
|
</dd>
|
|
14001
14722
|
</dl>
|
|
14002
14723
|
</dd>
|
|
@@ -14011,7 +14732,10 @@ Generate every invoice due up to `asOfDate` (default today) from the active sche
|
|
|
14011
14732
|
<dd>
|
|
14012
14733
|
|
|
14013
14734
|
```ruby
|
|
14014
|
-
client.sales.
|
|
14735
|
+
client.sales.recognition_modify(
|
|
14736
|
+
invoice_line_id: "invoiceLineId",
|
|
14737
|
+
approach: "prospective"
|
|
14738
|
+
)
|
|
14015
14739
|
```
|
|
14016
14740
|
</dd>
|
|
14017
14741
|
</dl>
|
|
@@ -14026,7 +14750,39 @@ client.sales.recurring_invoices_run
|
|
|
14026
14750
|
<dl>
|
|
14027
14751
|
<dd>
|
|
14028
14752
|
|
|
14029
|
-
**
|
|
14753
|
+
**invoice_line_id:** `String`
|
|
14754
|
+
|
|
14755
|
+
</dd>
|
|
14756
|
+
</dl>
|
|
14757
|
+
|
|
14758
|
+
<dl>
|
|
14759
|
+
<dd>
|
|
14760
|
+
|
|
14761
|
+
**approach:** `Nordlet::Sales::Types::RecognitionModifySalesRequestApproach`
|
|
14762
|
+
|
|
14763
|
+
</dd>
|
|
14764
|
+
</dl>
|
|
14765
|
+
|
|
14766
|
+
<dl>
|
|
14767
|
+
<dd>
|
|
14768
|
+
|
|
14769
|
+
**date:** `String`
|
|
14770
|
+
|
|
14771
|
+
</dd>
|
|
14772
|
+
</dl>
|
|
14773
|
+
|
|
14774
|
+
<dl>
|
|
14775
|
+
<dd>
|
|
14776
|
+
|
|
14777
|
+
**new_end_date:** `String`
|
|
14778
|
+
|
|
14779
|
+
</dd>
|
|
14780
|
+
</dl>
|
|
14781
|
+
|
|
14782
|
+
<dl>
|
|
14783
|
+
<dd>
|
|
14784
|
+
|
|
14785
|
+
**new_milestones:** `Internal::Types::Array[Nordlet::Sales::Types::RecognitionModifySalesRequestNewMilestonesItem]`
|
|
14030
14786
|
|
|
14031
14787
|
</dd>
|
|
14032
14788
|
</dl>
|
|
@@ -14046,7 +14802,7 @@ client.sales.recurring_invoices_run
|
|
|
14046
14802
|
</dl>
|
|
14047
14803
|
</details>
|
|
14048
14804
|
|
|
14049
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
14805
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recognition_runs_list</a>(request) -> Nordlet::Sales::Types::RecognitionRunsListSalesResponse</code></summary>
|
|
14050
14806
|
<dl>
|
|
14051
14807
|
<dd>
|
|
14052
14808
|
|
|
@@ -14058,7 +14814,7 @@ client.sales.recurring_invoices_run
|
|
|
14058
14814
|
<dl>
|
|
14059
14815
|
<dd>
|
|
14060
14816
|
|
|
14061
|
-
List
|
|
14817
|
+
List the revenue recognition runs, newest first; filterable by `runDate` and `trigger`, sortable by `runDate` and `createdAt`.
|
|
14062
14818
|
</dd>
|
|
14063
14819
|
</dl>
|
|
14064
14820
|
</dd>
|
|
@@ -14073,7 +14829,7 @@ List recurring invoice schedules with the names of their template and partner. F
|
|
|
14073
14829
|
<dd>
|
|
14074
14830
|
|
|
14075
14831
|
```ruby
|
|
14076
|
-
client.sales.
|
|
14832
|
+
client.sales.recognition_runs_list
|
|
14077
14833
|
```
|
|
14078
14834
|
</dd>
|
|
14079
14835
|
</dl>
|
|
@@ -14104,7 +14860,7 @@ client.sales.recurring_invoices_list
|
|
|
14104
14860
|
<dl>
|
|
14105
14861
|
<dd>
|
|
14106
14862
|
|
|
14107
|
-
**sort:** `Internal::Types::Array[Nordlet::Sales::Types::
|
|
14863
|
+
**sort:** `Internal::Types::Array[Nordlet::Sales::Types::RecognitionRunsListSalesRequestSortItem]`
|
|
14108
14864
|
|
|
14109
14865
|
</dd>
|
|
14110
14866
|
</dl>
|
|
@@ -14112,7 +14868,7 @@ client.sales.recurring_invoices_list
|
|
|
14112
14868
|
<dl>
|
|
14113
14869
|
<dd>
|
|
14114
14870
|
|
|
14115
|
-
**filter:** `Internal::Types::Array[Nordlet::Sales::Types::
|
|
14871
|
+
**filter:** `Internal::Types::Array[Nordlet::Sales::Types::RecognitionRunsListSalesRequestFilterItem]`
|
|
14116
14872
|
|
|
14117
14873
|
</dd>
|
|
14118
14874
|
</dl>
|
|
@@ -14140,7 +14896,7 @@ client.sales.recurring_invoices_list
|
|
|
14140
14896
|
</dl>
|
|
14141
14897
|
</details>
|
|
14142
14898
|
|
|
14143
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
14899
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">recognition_summary</a>(request) -> Nordlet::Sales::Types::RecognitionSummarySalesResponse</code></summary>
|
|
14144
14900
|
<dl>
|
|
14145
14901
|
<dd>
|
|
14146
14902
|
|
|
@@ -14152,7 +14908,7 @@ client.sales.recurring_invoices_list
|
|
|
14152
14908
|
<dl>
|
|
14153
14909
|
<dd>
|
|
14154
14910
|
|
|
14155
|
-
|
|
14911
|
+
Deferred revenue per line of the issued standard invoices whose recognition method is not `point_in_time`: the deferred total, the amount recognised so far, the remainder, the number of pending schedules and the next schedule date, with totals; `invoiceId` limits it to one invoice. For a `percent_complete` line the deferred total is the line's base amount, for the other methods the sum of its schedules.
|
|
14156
14912
|
</dd>
|
|
14157
14913
|
</dl>
|
|
14158
14914
|
</dd>
|
|
@@ -14167,7 +14923,7 @@ Preview the pending ratable revenue schedules due on or before `asOfDate` (defau
|
|
|
14167
14923
|
<dd>
|
|
14168
14924
|
|
|
14169
14925
|
```ruby
|
|
14170
|
-
client.sales.
|
|
14926
|
+
client.sales.recognition_summary
|
|
14171
14927
|
```
|
|
14172
14928
|
</dd>
|
|
14173
14929
|
</dl>
|
|
@@ -14182,7 +14938,7 @@ client.sales.recognition_compute
|
|
|
14182
14938
|
<dl>
|
|
14183
14939
|
<dd>
|
|
14184
14940
|
|
|
14185
|
-
**
|
|
14941
|
+
**invoice_id:** `String`
|
|
14186
14942
|
|
|
14187
14943
|
</dd>
|
|
14188
14944
|
</dl>
|
|
@@ -14202,7 +14958,7 @@ client.sales.recognition_compute
|
|
|
14202
14958
|
</dl>
|
|
14203
14959
|
</details>
|
|
14204
14960
|
|
|
14205
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
14961
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">refund_liability_list</a>(request) -> Nordlet::Sales::Types::RefundLiabilityListSalesResponse</code></summary>
|
|
14206
14962
|
<dl>
|
|
14207
14963
|
<dd>
|
|
14208
14964
|
|
|
@@ -14214,7 +14970,7 @@ client.sales.recognition_compute
|
|
|
14214
14970
|
<dl>
|
|
14215
14971
|
<dd>
|
|
14216
14972
|
|
|
14217
|
-
|
|
14973
|
+
List the refund liabilities of issued invoices (created at issue from the lines' `refundEstimatePercent` or by `sales/refund-liability/true-up`): the estimate, the part consumed by credit notes, the settlement refunds and the remaining amount (estimate less consumed), with the invoice number. Filterable by invoiceId; sortable by createdAt and updatedAt.
|
|
14218
14974
|
</dd>
|
|
14219
14975
|
</dl>
|
|
14220
14976
|
</dd>
|
|
@@ -14229,7 +14985,7 @@ Recognise deferred revenue: posts one journal entry dated `postingDate` (default
|
|
|
14229
14985
|
<dd>
|
|
14230
14986
|
|
|
14231
14987
|
```ruby
|
|
14232
|
-
client.sales.
|
|
14988
|
+
client.sales.refund_liability_list
|
|
14233
14989
|
```
|
|
14234
14990
|
</dd>
|
|
14235
14991
|
</dl>
|
|
@@ -14244,7 +15000,7 @@ client.sales.recognition_run
|
|
|
14244
15000
|
<dl>
|
|
14245
15001
|
<dd>
|
|
14246
15002
|
|
|
14247
|
-
**
|
|
15003
|
+
**page:** `Integer`
|
|
14248
15004
|
|
|
14249
15005
|
</dd>
|
|
14250
15006
|
</dl>
|
|
@@ -14252,7 +15008,7 @@ client.sales.recognition_run
|
|
|
14252
15008
|
<dl>
|
|
14253
15009
|
<dd>
|
|
14254
15010
|
|
|
14255
|
-
**
|
|
15011
|
+
**page_size:** `Integer`
|
|
14256
15012
|
|
|
14257
15013
|
</dd>
|
|
14258
15014
|
</dl>
|
|
@@ -14260,7 +15016,23 @@ client.sales.recognition_run
|
|
|
14260
15016
|
<dl>
|
|
14261
15017
|
<dd>
|
|
14262
15018
|
|
|
14263
|
-
**
|
|
15019
|
+
**sort:** `Internal::Types::Array[Nordlet::Sales::Types::RefundLiabilityListSalesRequestSortItem]`
|
|
15020
|
+
|
|
15021
|
+
</dd>
|
|
15022
|
+
</dl>
|
|
15023
|
+
|
|
15024
|
+
<dl>
|
|
15025
|
+
<dd>
|
|
15026
|
+
|
|
15027
|
+
**filter:** `Internal::Types::Array[Nordlet::Sales::Types::RefundLiabilityListSalesRequestFilterItem]`
|
|
15028
|
+
|
|
15029
|
+
</dd>
|
|
15030
|
+
</dl>
|
|
15031
|
+
|
|
15032
|
+
<dl>
|
|
15033
|
+
<dd>
|
|
15034
|
+
|
|
15035
|
+
**totals:** `Internal::Types::Array[String]` — Numeric fields to sum over every row matching the filter (not only the current page)
|
|
14264
15036
|
|
|
14265
15037
|
</dd>
|
|
14266
15038
|
</dl>
|
|
@@ -14280,7 +15052,7 @@ client.sales.recognition_run
|
|
|
14280
15052
|
</dl>
|
|
14281
15053
|
</details>
|
|
14282
15054
|
|
|
14283
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
15055
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">refund_liability_true_up</a>(request) -> Nordlet::Sales::Types::RefundLiabilityTrueUpSalesResponse</code></summary>
|
|
14284
15056
|
<dl>
|
|
14285
15057
|
<dd>
|
|
14286
15058
|
|
|
@@ -14292,7 +15064,7 @@ client.sales.recognition_run
|
|
|
14292
15064
|
<dl>
|
|
14293
15065
|
<dd>
|
|
14294
15066
|
|
|
14295
|
-
|
|
15067
|
+
Re-estimate the refund liability of an issued standard invoice to `estimatedTotal` and post the difference on `date` (default today) between the refund liability account and the invoice's revenue accounts, in proportion to the lines' allocated or net amounts; creates the liability when the invoice has none. Emits `refund_liability.trued_up`. Answers 422 when the invoice is not an issued standard invoice, when the estimate is below the amount already consumed or unchanged, or when the invoice has no revenue to allocate against; 409 when the accounting period is locked.
|
|
14296
15068
|
</dd>
|
|
14297
15069
|
</dl>
|
|
14298
15070
|
</dd>
|
|
@@ -14307,9 +15079,9 @@ Report the percentage of completion of a `percent_complete` invoice line and rec
|
|
|
14307
15079
|
<dd>
|
|
14308
15080
|
|
|
14309
15081
|
```ruby
|
|
14310
|
-
client.sales.
|
|
14311
|
-
|
|
14312
|
-
|
|
15082
|
+
client.sales.refund_liability_true_up(
|
|
15083
|
+
invoice_id: "invoiceId",
|
|
15084
|
+
estimated_total: "121.0000"
|
|
14313
15085
|
)
|
|
14314
15086
|
```
|
|
14315
15087
|
</dd>
|
|
@@ -14325,7 +15097,7 @@ client.sales.recognition_progress(
|
|
|
14325
15097
|
<dl>
|
|
14326
15098
|
<dd>
|
|
14327
15099
|
|
|
14328
|
-
**
|
|
15100
|
+
**invoice_id:** `String`
|
|
14329
15101
|
|
|
14330
15102
|
</dd>
|
|
14331
15103
|
</dl>
|
|
@@ -14333,7 +15105,7 @@ client.sales.recognition_progress(
|
|
|
14333
15105
|
<dl>
|
|
14334
15106
|
<dd>
|
|
14335
15107
|
|
|
14336
|
-
**
|
|
15108
|
+
**estimated_total:** `String`
|
|
14337
15109
|
|
|
14338
15110
|
</dd>
|
|
14339
15111
|
</dl>
|
|
@@ -14361,7 +15133,7 @@ client.sales.recognition_progress(
|
|
|
14361
15133
|
</dl>
|
|
14362
15134
|
</details>
|
|
14363
15135
|
|
|
14364
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
15136
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">payments_list</a>(request) -> Nordlet::Sales::Types::PaymentsListSalesResponse</code></summary>
|
|
14365
15137
|
<dl>
|
|
14366
15138
|
<dd>
|
|
14367
15139
|
|
|
@@ -14373,7 +15145,7 @@ client.sales.recognition_progress(
|
|
|
14373
15145
|
<dl>
|
|
14374
15146
|
<dd>
|
|
14375
15147
|
|
|
14376
|
-
|
|
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.
|
|
14377
15149
|
</dd>
|
|
14378
15150
|
</dl>
|
|
14379
15151
|
</dd>
|
|
@@ -14388,9 +15160,9 @@ Apply an IFRS 15 contract modification to a deferred invoice line. Prospective:
|
|
|
14388
15160
|
<dd>
|
|
14389
15161
|
|
|
14390
15162
|
```ruby
|
|
14391
|
-
client.sales.
|
|
14392
|
-
|
|
14393
|
-
|
|
15163
|
+
client.sales.payments_list(
|
|
15164
|
+
from: "2026-07-01",
|
|
15165
|
+
to: "2026-07-01"
|
|
14394
15166
|
)
|
|
14395
15167
|
```
|
|
14396
15168
|
</dd>
|
|
@@ -14406,15 +15178,7 @@ client.sales.recognition_modify(
|
|
|
14406
15178
|
<dl>
|
|
14407
15179
|
<dd>
|
|
14408
15180
|
|
|
14409
|
-
**
|
|
14410
|
-
|
|
14411
|
-
</dd>
|
|
14412
|
-
</dl>
|
|
14413
|
-
|
|
14414
|
-
<dl>
|
|
14415
|
-
<dd>
|
|
14416
|
-
|
|
14417
|
-
**approach:** `Nordlet::Sales::Types::RecognitionModifySalesRequestApproach`
|
|
15181
|
+
**from:** `String`
|
|
14418
15182
|
|
|
14419
15183
|
</dd>
|
|
14420
15184
|
</dl>
|
|
@@ -14422,7 +15186,7 @@ client.sales.recognition_modify(
|
|
|
14422
15186
|
<dl>
|
|
14423
15187
|
<dd>
|
|
14424
15188
|
|
|
14425
|
-
**
|
|
15189
|
+
**to:** `String`
|
|
14426
15190
|
|
|
14427
15191
|
</dd>
|
|
14428
15192
|
</dl>
|
|
@@ -14430,7 +15194,7 @@ client.sales.recognition_modify(
|
|
|
14430
15194
|
<dl>
|
|
14431
15195
|
<dd>
|
|
14432
15196
|
|
|
14433
|
-
**
|
|
15197
|
+
**page:** `Integer`
|
|
14434
15198
|
|
|
14435
15199
|
</dd>
|
|
14436
15200
|
</dl>
|
|
@@ -14438,7 +15202,7 @@ client.sales.recognition_modify(
|
|
|
14438
15202
|
<dl>
|
|
14439
15203
|
<dd>
|
|
14440
15204
|
|
|
14441
|
-
**
|
|
15205
|
+
**page_size:** `Integer`
|
|
14442
15206
|
|
|
14443
15207
|
</dd>
|
|
14444
15208
|
</dl>
|
|
@@ -14458,7 +15222,7 @@ client.sales.recognition_modify(
|
|
|
14458
15222
|
</dl>
|
|
14459
15223
|
</details>
|
|
14460
15224
|
|
|
14461
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
15225
|
+
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">exports_month</a>(request) -> Nordlet::Sales::Types::ExportsMonthSalesResponse</code></summary>
|
|
14462
15226
|
<dl>
|
|
14463
15227
|
<dd>
|
|
14464
15228
|
|
|
@@ -14470,7 +15234,7 @@ client.sales.recognition_modify(
|
|
|
14470
15234
|
<dl>
|
|
14471
15235
|
<dd>
|
|
14472
15236
|
|
|
14473
|
-
|
|
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`.
|
|
14474
15238
|
</dd>
|
|
14475
15239
|
</dl>
|
|
14476
15240
|
</dd>
|
|
@@ -14485,7 +15249,10 @@ List the revenue recognition runs, newest first; filterable by `runDate` and `tr
|
|
|
14485
15249
|
<dd>
|
|
14486
15250
|
|
|
14487
15251
|
```ruby
|
|
14488
|
-
client.sales.
|
|
15252
|
+
client.sales.exports_month(
|
|
15253
|
+
month: "month",
|
|
15254
|
+
format: "csv"
|
|
15255
|
+
)
|
|
14489
15256
|
```
|
|
14490
15257
|
</dd>
|
|
14491
15258
|
</dl>
|
|
@@ -14500,7 +15267,7 @@ client.sales.recognition_runs_list
|
|
|
14500
15267
|
<dl>
|
|
14501
15268
|
<dd>
|
|
14502
15269
|
|
|
14503
|
-
**
|
|
15270
|
+
**month:** `String`
|
|
14504
15271
|
|
|
14505
15272
|
</dd>
|
|
14506
15273
|
</dl>
|
|
@@ -14508,31 +15275,7 @@ client.sales.recognition_runs_list
|
|
|
14508
15275
|
<dl>
|
|
14509
15276
|
<dd>
|
|
14510
15277
|
|
|
14511
|
-
**
|
|
14512
|
-
|
|
14513
|
-
</dd>
|
|
14514
|
-
</dl>
|
|
14515
|
-
|
|
14516
|
-
<dl>
|
|
14517
|
-
<dd>
|
|
14518
|
-
|
|
14519
|
-
**sort:** `Internal::Types::Array[Nordlet::Sales::Types::RecognitionRunsListSalesRequestSortItem]`
|
|
14520
|
-
|
|
14521
|
-
</dd>
|
|
14522
|
-
</dl>
|
|
14523
|
-
|
|
14524
|
-
<dl>
|
|
14525
|
-
<dd>
|
|
14526
|
-
|
|
14527
|
-
**filter:** `Internal::Types::Array[Nordlet::Sales::Types::RecognitionRunsListSalesRequestFilterItem]`
|
|
14528
|
-
|
|
14529
|
-
</dd>
|
|
14530
|
-
</dl>
|
|
14531
|
-
|
|
14532
|
-
<dl>
|
|
14533
|
-
<dd>
|
|
14534
|
-
|
|
14535
|
-
**totals:** `Internal::Types::Array[String]` — Numeric fields to sum over every row matching the filter (not only the current page)
|
|
15278
|
+
**format:** `Nordlet::Sales::Types::ExportsMonthSalesRequestFormat`
|
|
14536
15279
|
|
|
14537
15280
|
</dd>
|
|
14538
15281
|
</dl>
|
|
@@ -14552,7 +15295,7 @@ client.sales.recognition_runs_list
|
|
|
14552
15295
|
</dl>
|
|
14553
15296
|
</details>
|
|
14554
15297
|
|
|
14555
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
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>
|
|
14556
15299
|
<dl>
|
|
14557
15300
|
<dd>
|
|
14558
15301
|
|
|
@@ -14564,7 +15307,7 @@ client.sales.recognition_runs_list
|
|
|
14564
15307
|
<dl>
|
|
14565
15308
|
<dd>
|
|
14566
15309
|
|
|
14567
|
-
|
|
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.
|
|
14568
15311
|
</dd>
|
|
14569
15312
|
</dl>
|
|
14570
15313
|
</dd>
|
|
@@ -14579,7 +15322,7 @@ Deferred revenue per line of the issued standard invoices whose recognition meth
|
|
|
14579
15322
|
<dd>
|
|
14580
15323
|
|
|
14581
15324
|
```ruby
|
|
14582
|
-
client.sales.
|
|
15325
|
+
client.sales.invoices_card_payments_get
|
|
14583
15326
|
```
|
|
14584
15327
|
</dd>
|
|
14585
15328
|
</dl>
|
|
@@ -14594,14 +15337,6 @@ client.sales.recognition_summary
|
|
|
14594
15337
|
<dl>
|
|
14595
15338
|
<dd>
|
|
14596
15339
|
|
|
14597
|
-
**invoice_id:** `String`
|
|
14598
|
-
|
|
14599
|
-
</dd>
|
|
14600
|
-
</dl>
|
|
14601
|
-
|
|
14602
|
-
<dl>
|
|
14603
|
-
<dd>
|
|
14604
|
-
|
|
14605
15340
|
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
14606
15341
|
|
|
14607
15342
|
</dd>
|
|
@@ -14614,7 +15349,7 @@ client.sales.recognition_summary
|
|
|
14614
15349
|
</dl>
|
|
14615
15350
|
</details>
|
|
14616
15351
|
|
|
14617
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
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>
|
|
14618
15353
|
<dl>
|
|
14619
15354
|
<dd>
|
|
14620
15355
|
|
|
@@ -14626,7 +15361,7 @@ client.sales.recognition_summary
|
|
|
14626
15361
|
<dl>
|
|
14627
15362
|
<dd>
|
|
14628
15363
|
|
|
14629
|
-
|
|
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.
|
|
14630
15365
|
</dd>
|
|
14631
15366
|
</dl>
|
|
14632
15367
|
</dd>
|
|
@@ -14641,7 +15376,10 @@ List the refund liabilities of issued invoices (created at issue from the lines'
|
|
|
14641
15376
|
<dd>
|
|
14642
15377
|
|
|
14643
15378
|
```ruby
|
|
14644
|
-
client.sales.
|
|
15379
|
+
client.sales.invoices_card_payments_connect(
|
|
15380
|
+
return_url: "returnUrl",
|
|
15381
|
+
refresh_url: "refreshUrl"
|
|
15382
|
+
)
|
|
14645
15383
|
```
|
|
14646
15384
|
</dd>
|
|
14647
15385
|
</dl>
|
|
@@ -14656,7 +15394,7 @@ client.sales.refund_liability_list
|
|
|
14656
15394
|
<dl>
|
|
14657
15395
|
<dd>
|
|
14658
15396
|
|
|
14659
|
-
**
|
|
15397
|
+
**return_url:** `String`
|
|
14660
15398
|
|
|
14661
15399
|
</dd>
|
|
14662
15400
|
</dl>
|
|
@@ -14664,31 +15402,7 @@ client.sales.refund_liability_list
|
|
|
14664
15402
|
<dl>
|
|
14665
15403
|
<dd>
|
|
14666
15404
|
|
|
14667
|
-
**
|
|
14668
|
-
|
|
14669
|
-
</dd>
|
|
14670
|
-
</dl>
|
|
14671
|
-
|
|
14672
|
-
<dl>
|
|
14673
|
-
<dd>
|
|
14674
|
-
|
|
14675
|
-
**sort:** `Internal::Types::Array[Nordlet::Sales::Types::RefundLiabilityListSalesRequestSortItem]`
|
|
14676
|
-
|
|
14677
|
-
</dd>
|
|
14678
|
-
</dl>
|
|
14679
|
-
|
|
14680
|
-
<dl>
|
|
14681
|
-
<dd>
|
|
14682
|
-
|
|
14683
|
-
**filter:** `Internal::Types::Array[Nordlet::Sales::Types::RefundLiabilityListSalesRequestFilterItem]`
|
|
14684
|
-
|
|
14685
|
-
</dd>
|
|
14686
|
-
</dl>
|
|
14687
|
-
|
|
14688
|
-
<dl>
|
|
14689
|
-
<dd>
|
|
14690
|
-
|
|
14691
|
-
**totals:** `Internal::Types::Array[String]` — Numeric fields to sum over every row matching the filter (not only the current page)
|
|
15405
|
+
**refresh_url:** `String`
|
|
14692
15406
|
|
|
14693
15407
|
</dd>
|
|
14694
15408
|
</dl>
|
|
@@ -14708,7 +15422,7 @@ client.sales.refund_liability_list
|
|
|
14708
15422
|
</dl>
|
|
14709
15423
|
</details>
|
|
14710
15424
|
|
|
14711
|
-
<details><summary><code>client.sales.<a href="/lib/nordlet/sales/client.rb">
|
|
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>
|
|
14712
15426
|
<dl>
|
|
14713
15427
|
<dd>
|
|
14714
15428
|
|
|
@@ -14720,7 +15434,7 @@ client.sales.refund_liability_list
|
|
|
14720
15434
|
<dl>
|
|
14721
15435
|
<dd>
|
|
14722
15436
|
|
|
14723
|
-
|
|
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.
|
|
14724
15438
|
</dd>
|
|
14725
15439
|
</dl>
|
|
14726
15440
|
</dd>
|
|
@@ -14735,10 +15449,7 @@ Re-estimate the refund liability of an issued standard invoice to `estimatedTota
|
|
|
14735
15449
|
<dd>
|
|
14736
15450
|
|
|
14737
15451
|
```ruby
|
|
14738
|
-
client.sales.
|
|
14739
|
-
invoice_id: "invoiceId",
|
|
14740
|
-
estimated_total: "121.0000"
|
|
14741
|
-
)
|
|
15452
|
+
client.sales.invoices_card_payments_disconnect
|
|
14742
15453
|
```
|
|
14743
15454
|
</dd>
|
|
14744
15455
|
</dl>
|
|
@@ -14753,30 +15464,6 @@ client.sales.refund_liability_true_up(
|
|
|
14753
15464
|
<dl>
|
|
14754
15465
|
<dd>
|
|
14755
15466
|
|
|
14756
|
-
**invoice_id:** `String`
|
|
14757
|
-
|
|
14758
|
-
</dd>
|
|
14759
|
-
</dl>
|
|
14760
|
-
|
|
14761
|
-
<dl>
|
|
14762
|
-
<dd>
|
|
14763
|
-
|
|
14764
|
-
**estimated_total:** `String`
|
|
14765
|
-
|
|
14766
|
-
</dd>
|
|
14767
|
-
</dl>
|
|
14768
|
-
|
|
14769
|
-
<dl>
|
|
14770
|
-
<dd>
|
|
14771
|
-
|
|
14772
|
-
**date:** `String`
|
|
14773
|
-
|
|
14774
|
-
</dd>
|
|
14775
|
-
</dl>
|
|
14776
|
-
|
|
14777
|
-
<dl>
|
|
14778
|
-
<dd>
|
|
14779
|
-
|
|
14780
15467
|
**request_options:** `Nordlet::Sales::RequestOptions`
|
|
14781
15468
|
|
|
14782
15469
|
</dd>
|
|
@@ -23254,7 +23941,7 @@ client.declarations.cy_he32generate(year: 1000000)
|
|
|
23254
23941
|
<dl>
|
|
23255
23942
|
<dd>
|
|
23256
23943
|
|
|
23257
|
-
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.
|
|
23258
23945
|
</dd>
|
|
23259
23946
|
</dl>
|
|
23260
23947
|
</dd>
|
|
@@ -23311,6 +23998,68 @@ client.declarations.de_returns_generate(
|
|
|
23311
23998
|
</dl>
|
|
23312
23999
|
|
|
23313
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
|
+
|
|
23314
24063
|
</dd>
|
|
23315
24064
|
</dl>
|
|
23316
24065
|
</details>
|
|
@@ -23327,7 +24076,7 @@ client.declarations.de_returns_generate(
|
|
|
23327
24076
|
<dl>
|
|
23328
24077
|
<dd>
|
|
23329
24078
|
|
|
23330
|
-
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.
|
|
23331
24080
|
</dd>
|
|
23332
24081
|
</dl>
|
|
23333
24082
|
</dd>
|
|
@@ -54110,7 +54859,106 @@ client.consolidation.intercompany_report(
|
|
|
54110
54859
|
</dl>
|
|
54111
54860
|
</details>
|
|
54112
54861
|
|
|
54113
|
-
<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>
|
|
54114
54962
|
<dl>
|
|
54115
54963
|
<dd>
|
|
54116
54964
|
|
|
@@ -54122,7 +54970,7 @@ client.consolidation.intercompany_report(
|
|
|
54122
54970
|
<dl>
|
|
54123
54971
|
<dd>
|
|
54124
54972
|
|
|
54125
|
-
|
|
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.
|
|
54126
54974
|
</dd>
|
|
54127
54975
|
</dl>
|
|
54128
54976
|
</dd>
|
|
@@ -54137,10 +54985,10 @@ Consolidated financial statements of a group for a period in its presentation cu
|
|
|
54137
54985
|
<dd>
|
|
54138
54986
|
|
|
54139
54987
|
```ruby
|
|
54140
|
-
client.
|
|
54141
|
-
|
|
54142
|
-
|
|
54143
|
-
|
|
54988
|
+
client.public.integration_requests(
|
|
54989
|
+
integration: "integration",
|
|
54990
|
+
name: "name",
|
|
54991
|
+
email: "email"
|
|
54144
54992
|
)
|
|
54145
54993
|
```
|
|
54146
54994
|
</dd>
|
|
@@ -54156,7 +55004,7 @@ client.consolidation.report(
|
|
|
54156
55004
|
<dl>
|
|
54157
55005
|
<dd>
|
|
54158
55006
|
|
|
54159
|
-
**
|
|
55007
|
+
**integration:** `String`
|
|
54160
55008
|
|
|
54161
55009
|
</dd>
|
|
54162
55010
|
</dl>
|
|
@@ -54164,7 +55012,7 @@ client.consolidation.report(
|
|
|
54164
55012
|
<dl>
|
|
54165
55013
|
<dd>
|
|
54166
55014
|
|
|
54167
|
-
**
|
|
55015
|
+
**name:** `String`
|
|
54168
55016
|
|
|
54169
55017
|
</dd>
|
|
54170
55018
|
</dl>
|
|
@@ -54172,7 +55020,7 @@ client.consolidation.report(
|
|
|
54172
55020
|
<dl>
|
|
54173
55021
|
<dd>
|
|
54174
55022
|
|
|
54175
|
-
**
|
|
55023
|
+
**company:** `String`
|
|
54176
55024
|
|
|
54177
55025
|
</dd>
|
|
54178
55026
|
</dl>
|
|
@@ -54180,7 +55028,7 @@ client.consolidation.report(
|
|
|
54180
55028
|
<dl>
|
|
54181
55029
|
<dd>
|
|
54182
55030
|
|
|
54183
|
-
**
|
|
55031
|
+
**email:** `String`
|
|
54184
55032
|
|
|
54185
55033
|
</dd>
|
|
54186
55034
|
</dl>
|
|
@@ -54188,7 +55036,7 @@ client.consolidation.report(
|
|
|
54188
55036
|
<dl>
|
|
54189
55037
|
<dd>
|
|
54190
55038
|
|
|
54191
|
-
**
|
|
55039
|
+
**details:** `String`
|
|
54192
55040
|
|
|
54193
55041
|
</dd>
|
|
54194
55042
|
</dl>
|
|
@@ -54196,7 +55044,15 @@ client.consolidation.report(
|
|
|
54196
55044
|
<dl>
|
|
54197
55045
|
<dd>
|
|
54198
55046
|
|
|
54199
|
-
**
|
|
55047
|
+
**website:** `String`
|
|
55048
|
+
|
|
55049
|
+
</dd>
|
|
55050
|
+
</dl>
|
|
55051
|
+
|
|
55052
|
+
<dl>
|
|
55053
|
+
<dd>
|
|
55054
|
+
|
|
55055
|
+
**request_options:** `Nordlet::Public::RequestOptions`
|
|
54200
55056
|
|
|
54201
55057
|
</dd>
|
|
54202
55058
|
</dl>
|
|
@@ -54208,8 +55064,7 @@ client.consolidation.report(
|
|
|
54208
55064
|
</dl>
|
|
54209
55065
|
</details>
|
|
54210
55066
|
|
|
54211
|
-
|
|
54212
|
-
<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>
|
|
54213
55068
|
<dl>
|
|
54214
55069
|
<dd>
|
|
54215
55070
|
|
|
@@ -54221,7 +55076,7 @@ client.consolidation.report(
|
|
|
54221
55076
|
<dl>
|
|
54222
55077
|
<dd>
|
|
54223
55078
|
|
|
54224
|
-
|
|
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.
|
|
54225
55080
|
</dd>
|
|
54226
55081
|
</dl>
|
|
54227
55082
|
</dd>
|
|
@@ -54236,11 +55091,7 @@ Store a request for an integration: the integration asked for and the sender's n
|
|
|
54236
55091
|
<dd>
|
|
54237
55092
|
|
|
54238
55093
|
```ruby
|
|
54239
|
-
client.public.
|
|
54240
|
-
integration: "integration",
|
|
54241
|
-
name: "name",
|
|
54242
|
-
email: "email"
|
|
54243
|
-
)
|
|
55094
|
+
client.public.pay(token: "token")
|
|
54244
55095
|
```
|
|
54245
55096
|
</dd>
|
|
54246
55097
|
</dl>
|
|
@@ -54255,7 +55106,7 @@ client.public.integration_requests(
|
|
|
54255
55106
|
<dl>
|
|
54256
55107
|
<dd>
|
|
54257
55108
|
|
|
54258
|
-
**
|
|
55109
|
+
**token:** `String`
|
|
54259
55110
|
|
|
54260
55111
|
</dd>
|
|
54261
55112
|
</dl>
|
|
@@ -54263,23 +55114,61 @@ client.public.integration_requests(
|
|
|
54263
55114
|
<dl>
|
|
54264
55115
|
<dd>
|
|
54265
55116
|
|
|
54266
|
-
**
|
|
55117
|
+
**request_options:** `Nordlet::Public::RequestOptions`
|
|
54267
55118
|
|
|
54268
55119
|
</dd>
|
|
54269
55120
|
</dl>
|
|
55121
|
+
</dd>
|
|
55122
|
+
</dl>
|
|
55123
|
+
|
|
55124
|
+
|
|
55125
|
+
</dd>
|
|
55126
|
+
</dl>
|
|
55127
|
+
</details>
|
|
54270
55128
|
|
|
55129
|
+
<details><summary><code>client.public.<a href="/lib/nordlet/public/client.rb">invoices_get</a>(request) -> Nordlet::Public::Types::InvoicesGetPublicResponse</code></summary>
|
|
54271
55130
|
<dl>
|
|
54272
55131
|
<dd>
|
|
54273
55132
|
|
|
54274
|
-
|
|
54275
|
-
|
|
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.
|
|
55142
|
+
</dd>
|
|
55143
|
+
</dl>
|
|
54276
55144
|
</dd>
|
|
54277
55145
|
</dl>
|
|
54278
55146
|
|
|
55147
|
+
#### 🔌 Usage
|
|
55148
|
+
|
|
54279
55149
|
<dl>
|
|
54280
55150
|
<dd>
|
|
54281
55151
|
|
|
54282
|
-
|
|
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`
|
|
54283
55172
|
|
|
54284
55173
|
</dd>
|
|
54285
55174
|
</dl>
|
|
@@ -54287,15 +55176,61 @@ client.public.integration_requests(
|
|
|
54287
55176
|
<dl>
|
|
54288
55177
|
<dd>
|
|
54289
55178
|
|
|
54290
|
-
**
|
|
55179
|
+
**request_options:** `Nordlet::Public::RequestOptions`
|
|
54291
55180
|
|
|
54292
55181
|
</dd>
|
|
54293
55182
|
</dl>
|
|
55183
|
+
</dd>
|
|
55184
|
+
</dl>
|
|
55185
|
+
|
|
55186
|
+
|
|
55187
|
+
</dd>
|
|
55188
|
+
</dl>
|
|
55189
|
+
</details>
|
|
54294
55190
|
|
|
55191
|
+
<details><summary><code>client.public.<a href="/lib/nordlet/public/client.rb">invoices_checkout</a>(request) -> Nordlet::Public::Types::InvoicesCheckoutPublicResponse</code></summary>
|
|
54295
55192
|
<dl>
|
|
54296
55193
|
<dd>
|
|
54297
55194
|
|
|
54298
|
-
|
|
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`
|
|
54299
55234
|
|
|
54300
55235
|
</dd>
|
|
54301
55236
|
</dl>
|
|
@@ -54315,7 +55250,7 @@ client.public.integration_requests(
|
|
|
54315
55250
|
</dl>
|
|
54316
55251
|
</details>
|
|
54317
55252
|
|
|
54318
|
-
<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>
|
|
54319
55254
|
<dl>
|
|
54320
55255
|
<dd>
|
|
54321
55256
|
|
|
@@ -54327,7 +55262,7 @@ client.public.integration_requests(
|
|
|
54327
55262
|
<dl>
|
|
54328
55263
|
<dd>
|
|
54329
55264
|
|
|
54330
|
-
|
|
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.
|
|
54331
55266
|
</dd>
|
|
54332
55267
|
</dl>
|
|
54333
55268
|
</dd>
|
|
@@ -54342,7 +55277,7 @@ Redirect (302) to the company's payment page for the issued invoice that carries
|
|
|
54342
55277
|
<dd>
|
|
54343
55278
|
|
|
54344
55279
|
```ruby
|
|
54345
|
-
client.public.
|
|
55280
|
+
client.public.invoices_pdf(token: "token")
|
|
54346
55281
|
```
|
|
54347
55282
|
</dd>
|
|
54348
55283
|
</dl>
|
|
@@ -54843,7 +55778,7 @@ client.billing.topup_confirm(session_id: "sessionId")
|
|
|
54843
55778
|
<dl>
|
|
54844
55779
|
<dd>
|
|
54845
55780
|
|
|
54846
|
-
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.
|
|
54847
55782
|
</dd>
|
|
54848
55783
|
</dl>
|
|
54849
55784
|
</dd>
|
|
@@ -54959,6 +55894,60 @@ client.billing.flat_rate_confirm(session_id: "sessionId")
|
|
|
54959
55894
|
</dl>
|
|
54960
55895
|
|
|
54961
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
|
+
|
|
54962
55951
|
</dd>
|
|
54963
55952
|
</dl>
|
|
54964
55953
|
</details>
|
|
@@ -55173,7 +56162,7 @@ client.billing.usage_list(
|
|
|
55173
56162
|
<dl>
|
|
55174
56163
|
<dd>
|
|
55175
56164
|
|
|
55176
|
-
Create a sign-in link for the e-mail address and send it; the link is valid for 15 minutes and is consumed with `account/login-link/consume`. When an unused link was requested for the same address within the last minute, the call answers `sent` without sending another. `locale` sets the language of the e-mail and of the link; `acceptTerms`, `acceptDpa` and `referralCode` are stored with the link and used when the address has no account yet.
|
|
56165
|
+
Create a sign-in link for the e-mail address and send it; the link is valid for 15 minutes and is consumed with `account/login-link/consume`. When an unused link was requested for the same address within the last minute, the call answers `sent` without sending another. `locale` sets the language of the e-mail and of the link; `app` set to `invoice` makes the link open the invoice app instead of the Nordlet app; `acceptTerms`, `acceptDpa` and `referralCode` are stored with the link and used when the address has no account yet.
|
|
55177
56166
|
</dd>
|
|
55178
56167
|
</dl>
|
|
55179
56168
|
</dd>
|
|
@@ -55243,6 +56232,14 @@ client.account.login_link_request(email: "email")
|
|
|
55243
56232
|
<dl>
|
|
55244
56233
|
<dd>
|
|
55245
56234
|
|
|
56235
|
+
**app:** `Nordlet::Account::Types::LoginLinkRequestAccountRequestApp`
|
|
56236
|
+
|
|
56237
|
+
</dd>
|
|
56238
|
+
</dl>
|
|
56239
|
+
|
|
56240
|
+
<dl>
|
|
56241
|
+
<dd>
|
|
56242
|
+
|
|
55246
56243
|
**request_options:** `Nordlet::Account::RequestOptions`
|
|
55247
56244
|
|
|
55248
56245
|
</dd>
|
|
@@ -56253,6 +57250,62 @@ client.account.companies_create(name: "name")
|
|
|
56253
57250
|
<dl>
|
|
56254
57251
|
<dd>
|
|
56255
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
|
+
|
|
56256
57309
|
**peppol_id:** `String`
|
|
56257
57310
|
|
|
56258
57311
|
</dd>
|
|
@@ -56373,6 +57426,14 @@ client.account.companies_create(name: "name")
|
|
|
56373
57426
|
<dl>
|
|
56374
57427
|
<dd>
|
|
56375
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
|
+
|
|
56376
57437
|
**request_options:** `Nordlet::Account::RequestOptions`
|
|
56377
57438
|
|
|
56378
57439
|
</dd>
|
|
@@ -56513,7 +57574,7 @@ client.account.companies_profile
|
|
|
56513
57574
|
<dl>
|
|
56514
57575
|
<dd>
|
|
56515
57576
|
|
|
56516
|
-
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.
|
|
56517
57578
|
</dd>
|
|
56518
57579
|
</dl>
|
|
56519
57580
|
</dd>
|
|
@@ -56655,6 +57716,62 @@ client.account.companies_update
|
|
|
56655
57716
|
<dl>
|
|
56656
57717
|
<dd>
|
|
56657
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
|
+
|
|
56658
57775
|
**peppol_id:** `String`
|
|
56659
57776
|
|
|
56660
57777
|
</dd>
|