nordlet 0.5.4 → 0.5.6

data/lib/nordlet/bank/client.rb

@@ -10,6 +10,11 @@ module Nordlet
         @client = client
       end
 
+      # Create a bank, Stripe or broker account. `currency` defaults to the company base currency and `accountCode` to
+      # the default bank account of the chart of accounts. A `documentRef` also creates a bank agreement with that
+      # document attached. A Stripe account with an `iban` is refused with 422; an account with the same IBAN already
+      # existing answers 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::AccountsCreateBankRequest]
       # @option request_options [String] :base_url
@@ -42,6 +47,9 @@ module Nordlet
         end
       end
 
+      # List the bank accounts of the company. Filterable by name, type, iban and isActive; sortable by name and
+      # createdAt.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::AccountsListBankRequest]
       # @option request_options [String] :base_url
@@ -74,6 +82,9 @@ module Nordlet
         end
       end
 
+      # Change the name, type, IBAN, ledger account code or active flag of a bank account. Setting type to stripe clears
+      # the IBAN, and sending an `iban` together with it is refused with 422.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::AccountsUpdateBankRequest]
       # @option request_options [String] :base_url
@@ -106,6 +117,11 @@ module Nordlet
         end
       end
 
+      # Insert statement lines (up to 1000 per call) into a bank account as new transactions. A line without `currency`
+      # takes the account currency; a line in another currency is refused with 422. A line whose `externalId` is already
+      # on the account is skipped and counted in `skipped`. An incoming line that an active match rule
+      # (`bank/match-rules/create`) recognises is linked to its settlement batch.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::TransactionsImportBankRequest]
       # @option request_options [String] :base_url
@@ -138,6 +154,17 @@ module Nordlet
         end
       end
 
+      # Import a statement file into a bank account: camt.053 XML, MT940, a Stripe balance CSV or a Revolut Business
+      # CSV, chosen by `format` or by the type of `templateId` (an iso20022 template also takes MT940 content).
+      # Statements whose IBAN or currency differ from the account are left out; the call is refused with 422 when none
+      # remains, when a line is in another currency, when the file lacks the columns or elements the template requires
+      # or when it holds more than 50000 lines. Lines already on the account are skipped, and Stripe movements already
+      # posted through a settlement payout are skipped with a warning. With a template, the mapped fields are posted to
+      # their ledger accounts, partners are created, payments are matched to the invoices they reference, and invoices,
+      # credit notes or advance invoices are issued where the template asks for them (`invoiceMetaField`,
+      # `advanceInvoices`); `transfersCsv` posts the lender payouts and commissions of a Stripe template. Invoices
+      # issued this way are announced as `sale_invoice.issued`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::StatementsImportBankRequest]
       # @option request_options [String] :base_url
@@ -170,6 +197,9 @@ module Nordlet
         end
       end
 
+      # List the bank transactions of the company. Filterable by id, bankAccountId, status, matchedDocumentId, date,
+      # amount, counterpartyIban, counterpartyName and externalId; sortable by date, createdAt and amount.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::TransactionsListBankRequest]
       # @option request_options [String] :base_url
@@ -202,6 +232,15 @@ module Nordlet
         end
       end
 
+      # Match one new bank transaction to a document: an issued sale invoice or advance for incoming money; an issued
+      # sale credit note, a registered purchase invoice or an approved payroll run (company currency only) for outgoing
+      # money. Posts the payment journal transaction between the bank account and the receivable, payable or net payable
+      # account, with any exchange difference on the gain or loss account, raises the paid amount of the document and
+      # sets the line to matched. `invoiceAmount` states the amount settled on an invoice in another currency; in the
+      # same currency it must equal the payment (422). Answers 409 when the line is already matched, when the amount
+      # exceeds the remaining balance of the document or when the accounting period of the line date is locked. A
+      # document that becomes fully paid is announced as `sale_invoice.paid` or `purchase_invoice.paid`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::TransactionsMatchBankRequest]
       # @option request_options [String] :base_url
@@ -234,6 +273,14 @@ module Nordlet
         end
       end
 
+      # The documents are issued sale invoices or advances for incoming money; issued sale credit notes, registered
+      # purchase invoices or approved payroll runs for outgoing money. Each must be in the currency of the payment, each
+      # allocation must be above zero, a document may appear once and the allocations must add up to the payment (422
+      # otherwise). One journal transaction carries the bank entry, one entry per document and any exchange difference;
+      # the line is matched as an `invoice_allocation`. Answers 409 when the line is already matched, when an allocation
+      # exceeds the remaining balance of its document or when the accounting period of the line date is locked. Each
+      # document that becomes fully paid is announced as `sale_invoice.paid` or `purchase_invoice.paid`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::TransactionsMatchManyBankRequest]
       # @option request_options [String] :base_url
@@ -302,6 +349,11 @@ module Nordlet
         end
       end
 
+      # Record a payment that is on no imported statement: inserts a bank transaction on the account dated `date`
+      # (positive for a sale invoice, negative for a purchase invoice or payroll run, in the account currency) and
+      # matches it to the document with the checks, posting and `sale_invoice.paid` or `purchase_invoice.paid` event of
+      # `bank/transactions/match`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::TransactionsRecordBankRequest]
       # @option request_options [String] :base_url
@@ -334,6 +386,12 @@ module Nordlet
         end
       end
 
+      # Build a SEPA credit transfer file (pain.001.001.03) that pays the remaining amount of each registered purchase
+      # invoice from the bank account on `executionDate` (default: today), to the partner's default bank account. The
+      # bank account needs an IBAN and every invoice must be in EUR and have a partner bank account on file (422
+      # otherwise, see `partners/bank-accounts/create`); an invoice that is already paid answers 409. The file is
+      # returned as `xml`; nothing is posted or marked paid.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::PaymentsExportBankRequest]
       # @option request_options [String] :base_url
@@ -366,6 +424,13 @@ module Nordlet
         end
       end
 
+      # A template of type stripe, iso20022, revolut or bank_connection names the fields of the file or feed: a field
+      # with an `accountCode` is posted to that ledger account on import, a field with `createPartner` creates the
+      # customer, supplier or fee partner. `invoiceMetaField` is the Stripe metadata key (stripe) or the reference field
+      # (other types) by which payments are linked to invoices; with it `invoiceVatRatePercent`, `invoiceItemId` and,
+      # outside Stripe, `advanceInvoices` apply. `companyMetaField`, `lenderMetaField`, the operation types and the
+      # refund labels are for Stripe templates only. A template with the same name already existing answers 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::ImportTemplatesCreateBankRequest]
       # @option request_options [String] :base_url
@@ -398,6 +463,10 @@ module Nordlet
         end
       end
 
+      # Change a company import template under the rules of `bank/import-templates/create`; a change of `type` re-checks
+      # the existing fields against the new type. Built-in templates cannot be changed. A name already used by another
+      # template answers 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::ImportTemplatesUpdateBankRequest]
       # @option request_options [String] :base_url
@@ -430,6 +499,8 @@ module Nordlet
         end
       end
 
+      # Delete a company import template. Built-in templates cannot be deleted.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::ImportTemplatesDeleteBankRequest]
       # @option request_options [String] :base_url
@@ -462,6 +533,8 @@ module Nordlet
         end
       end
 
+      # Read one import template, a company one or a built-in one.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::ImportTemplatesGetBankRequest]
       # @option request_options [String] :base_url
@@ -494,6 +567,11 @@ module Nordlet
         end
       end
 
+      # Today the Revolut Business template: the Revolut CSV fields, with fees, card payments and top-ups posted to the
+      # accounts of the posting rules, the sender and beneficiary names creating partners and the Reference column
+      # linking payments to invoices. The rows carry `builtin: true`, are readable with `bank/import-templates/get` and
+      # are not in `bank/import-templates/list`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::ImportTemplatesListBuiltinBankRequest]
       # @option request_options [String] :base_url
@@ -526,6 +604,9 @@ module Nordlet
         end
       end
 
+      # List the import templates of the company (the built-in ones are under `bank/import-templates/list-builtin`).
+      # Filterable by name and type; sortable by name and createdAt.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::ImportTemplatesListBankRequest]
       # @option request_options [String] :base_url
@@ -558,6 +639,13 @@ module Nordlet
         end
       end
 
+      # Create a rule that links incoming bank lines to the settlement batches of a payment provider when lines are
+      # imported and when a batch is posted. A line whose description, counterparty name or external id contains
+      # `pattern` (case-insensitive) is linked to the open batch of `provider` whose payout id follows `payoutIdPrefix`
+      # in the line text or, without a prefix, to the single open batch on the same bank account with the same currency
+      # and net amount and a payout date within `dateWindowDays` of the line date. `bankAccountId` limits the rule to
+      # one account.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::MatchRulesCreateBankRequest]
       # @option request_options [String] :base_url
@@ -590,6 +678,8 @@ module Nordlet
         end
       end
 
+      # Change a match rule; `payoutIdPrefix` and `bankAccountId` are cleared with null.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::MatchRulesUpdateBankRequest]
       # @option request_options [String] :base_url
@@ -622,6 +712,8 @@ module Nordlet
         end
       end
 
+      # Delete a match rule.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::MatchRulesDeleteBankRequest]
       # @option request_options [String] :base_url
@@ -654,6 +746,8 @@ module Nordlet
         end
       end
 
+      # List the match rules of the company, ordered by name.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::MatchRulesListBankRequest]
       # @option request_options [String] :base_url
@@ -686,6 +780,11 @@ module Nordlet
         end
       end
 
+      # Record a SEPA direct debit mandate a partner has signed: debtor IBAN and BIC, scheme (CORE or B2B), recurrent or
+      # one-off, and the signature date. `reference` is the mandate reference written into the collection files; without
+      # one `MNDT-` followed by a generated id is used. `debtorName` defaults to the partner name. A reference already
+      # in use answers 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::MandatesCreateBankRequest]
       # @option request_options [String] :base_url
@@ -718,6 +817,8 @@ module Nordlet
         end
       end
 
+      # Change the BIC, debtor name or notes of a mandate.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::MandatesUpdateBankRequest]
       # @option request_options [String] :base_url
@@ -750,6 +851,8 @@ module Nordlet
         end
       end
 
+      # Cancel an active mandate. A mandate that is already cancelled or completed answers 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::MandatesCancelBankRequest]
       # @option request_options [String] :base_url
@@ -782,6 +885,9 @@ module Nordlet
         end
       end
 
+      # Read one mandate. `expiresOn` is 36 months after the last collection, or after the signature date when nothing
+      # has been collected.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::MandatesGetBankRequest]
       # @option request_options [String] :base_url
@@ -814,6 +920,9 @@ module Nordlet
         end
       end
 
+      # List the mandates of the company. Filterable by partnerId, status, scheme, reference and iban; sortable by
+      # createdAt and signatureDate.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::MandatesListBankRequest]
       # @option request_options [String] :base_url
@@ -846,6 +955,11 @@ module Nordlet
         end
       end
 
+      # List the issued EUR sale invoices that are unpaid or partly paid and whose partner holds an active mandate, each
+      # with the mandate `bank/direct-debits/export` would use (the most recently signed active one). Filterable by
+      # partnerId, fullNumber, issueDate and dueDate; sortable by issueDate, dueDate, fullNumber, grossTotal and
+      # createdAt.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::DirectDebitsCandidatesBankRequest]
       # @option request_options [String] :base_url
@@ -878,6 +992,15 @@ module Nordlet
         end
       end
 
+      # Build a SEPA direct debit file (pain.008.001.02) that collects the remaining amount of each issued EUR sale
+      # invoice into the bank account on `collectionDate` (default: today) under the partner's most recently signed
+      # active mandate. The bank account needs an IBAN and the company a valid `sepaCreditorId` (422, see
+      # `account/companies/update`); an invoice whose partner has no active mandate, or whose mandate expired (36 months
+      # without a collection), answers 422; an invoice already paid, or a one-off mandate asked to collect more than one
+      # invoice, answers 409. The sequence type is OOFF for a one-off mandate, FRST for the first collection under a
+      # recurrent one and RCUR after that. On success the collection count and last collection date of each mandate are
+      # advanced and a one-off mandate is completed; nothing is posted.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::DirectDebitsExportBankRequest]
       # @option request_options [String] :base_url
@@ -910,6 +1033,13 @@ module Nordlet
         end
       end
 
+      # Suggest documents for a new bank transaction: issued sale invoices and advances for incoming money; registered
+      # purchase invoices, issued sale credit notes and approved payroll runs for outgoing money. Candidates are unpaid
+      # documents whose remaining balance covers the payment (any balance when in another currency), scored by an equal
+      # remaining balance, the document number or payroll period in the payment description and a counterparty IBAN or
+      # name matching the partner or an employee on the run; the best `limit` come back with their reasons. A
+      # transaction that is already matched answers 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::TransactionsSuggestMatchesBankRequest]
       # @option request_options [String] :base_url
@@ -942,6 +1072,15 @@ module Nordlet
         end
       end
 
+      # Import a Stripe payout report into settlement batches, one per payout: the itemized payout reconciliation CSV
+      # (`format` payout_reconciliation) or the unified payments export with its Transfer column (unified_payments);
+      # another CSV is refused with 422. Rows without a payout, the payout rows themselves and unsettled payments are
+      # skipped and counted. Each line is matched to an issued sale invoice through the references the report carries
+      # (the external reference of a sales order or an invoice number) or through a charge matched earlier. A payout
+      # already imported receives its new lines while the batch is in status imported and is skipped once posted; a
+      # payout mixing currencies answers 422. Emits `settlement.imported` for a new batch and `settlement.updated` for
+      # one that received lines.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::SettlementsImportBankRequest]
       # @option request_options [String] :base_url
@@ -974,6 +1113,9 @@ module Nordlet
         end
       end
 
+      # List the settlement batches with their line counts and the clearing figures against the bank lines. Filterable
+      # by provider, payoutId, status, currency and bankAccountId; sortable by payoutDate, createdAt and netTotal.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::SettlementsListBankRequest]
       # @option request_options [String] :base_url
@@ -1006,6 +1148,9 @@ module Nordlet
         end
       end
 
+      # Read one settlement batch with its lines, each with the invoice it is matched to and the bank line that cleared
+      # it (`clearingBooked`, `clearingDifference`, `clearingUnposted`).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::SettlementsGetBankRequest]
       # @option request_options [String] :base_url
@@ -1038,6 +1183,10 @@ module Nordlet
         end
       end
 
+      # Match a settlement line to an issued sale invoice or advance by hand (`matchStatus` manual), or clear the match
+      # with `invoiceId` null. Only lines of the categories charge, refund, dispute, dispute_reversal and
+      # partial_capture_reversal can be matched (422), and only while the batch is in status imported (409).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::SettlementsMatchBankRequest]
       # @option request_options [String] :base_url
@@ -1174,6 +1323,18 @@ module Nordlet
         end
       end
 
+      # Post a settlement batch dated `date` (default: the payout date, else today): the bank account receives the net
+      # payout, the matched sale invoices are settled against the receivable (the receivable of each partner in a
+      # journal transaction of its own when invoices of several partners are settled), the provider fees, the
+      # marketplace commission and the seller payable are booked, and a payout in another currency is converted at the
+      # rate of that date with the exchange difference against each invoice's own rate on the gain or loss account. A
+      # line without a matched invoice is split by its own rate or amount, else by `commissionPercent`, else parked on
+      # the suspense account; a line already imported as a movement of a bank account is posted against that account
+      # instead. Answers 409 when the batch is already posted or the period is locked, 422 when it has no lines. The
+      # payout is linked to the bank line a match rule recognises. Emits `settlement.posted`, `sale_invoice.paid` for
+      # each invoice that becomes paid and `refund_liability.actual` for refunds of invoices carrying a refund
+      # liability.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::SettlementsPostBankRequest]
       # @option request_options [String] :base_url
@@ -1206,6 +1367,15 @@ module Nordlet
         end
       end
 
+      # Import an Interactive Brokers activity statement (CSV) into a bank account of type `broker`; refused with 422
+      # for another account type, a file that is not an IBKR statement, a statement of a different IBKR account than the
+      # bank account already holds, or a trade older than the latest trade already imported (statements go in in date
+      # order). Rows already imported are skipped. Dividends, withholding tax, interest and fees are posted against the
+      # broker account; stock, option and futures trades are matched FIFO against the open lots and post the cost to
+      # `securities.investments` and the realised result to `securities.gain` or `securities.loss` (posting rules), one
+      # journal entry per date in the base currency at the rate of the day (422 without a rate, 409 when the date's
+      # period is locked). Deposits, corporate actions and currency conversions are stored as `not_posted` with a note.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::SecuritiesImportBankRequest]
       # @option request_options [String] :base_url
@@ -1238,6 +1408,9 @@ module Nordlet
         end
       end
 
+      # List the securities imports, newest first; filterable by `bankAccountId` and `brokerAccount`, sortable by
+      # `createdAt` and `realizedTotal`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::SecuritiesListBankRequest]
       # @option request_options [String] :base_url
@@ -1270,6 +1443,9 @@ module Nordlet
         end
       end
 
+      # Return one securities import with its operations in date order, each with its posting status, its amounts in the
+      # base currency and the journal transaction it was posted in.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::SecuritiesGetBankRequest]
       # @option request_options [String] :base_url
@@ -1302,6 +1478,9 @@ module Nordlet
         end
       end
 
+      # List the imported securities operations, newest first; filterable by `bankAccountId`, `kind`, `status`, `symbol`
+      # and `date`, sortable by `date` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::SecuritiesOperationsListBankRequest]
       # @option request_options [String] :base_url
@@ -1334,6 +1513,9 @@ module Nordlet
         end
       end
 
+      # Read from the bank-feed provider configured on the API server or in platform settings (Enable Banking or an HTTP
+      # bridge, named in `provider`), for one `country` or all. Without a provider the call answers 503.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::FeedsBanksListBankRequest]
       # @option request_options [String] :base_url
@@ -1366,6 +1548,11 @@ module Nordlet
         end
       end
 
+      # Creates a pending bank connection and asks the provider for the authorization page of the bank. `url` is where
+      # the user authorizes access for `validForDays` (default 90); `reference` is the state the bank sends back and
+      # what `bank/feeds/connections/complete` takes. `redirectUrl` falls back to the one in platform settings, and the
+      # call is refused with 422 when neither is set.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::FeedsConnectionsStartBankRequest]
       # @option request_options [String] :base_url
@@ -1398,6 +1585,11 @@ module Nordlet
         end
       end
 
+      # Exchanges `code` for a provider session, sets the connection to active with the consent expiry the bank reports,
+      # and records every account of the session as a bank-feed account, not yet linked to a ledger account
+      # (`bank/feeds/accounts/link`). A connection that is already active answers 409. When the provider refuses the
+      # code the connection goes to status error with the message in `error`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::FeedsConnectionsCompleteBankRequest]
       # @option request_options [String] :base_url
@@ -1430,6 +1622,8 @@ module Nordlet
         end
       end
 
+      # Read one bank connection with its bank-feed accounts.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::FeedsConnectionsGetBankRequest]
       # @option request_options [String] :base_url
@@ -1462,6 +1656,9 @@ module Nordlet
         end
       end
 
+      # List the bank connections of the company, without their accounts. Filterable by status, provider and
+      # aspspCountry; sortable by createdAt and lastSyncedAt.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::FeedsConnectionsListBankRequest]
       # @option request_options [String] :base_url
@@ -1494,6 +1691,10 @@ module Nordlet
         end
       end
 
+      # Closes the provider session when the connection has one and a provider is configured (a failure at the bank does
+      # not stop the call), then deletes the connection and its bank-feed accounts. The ledger bank accounts and the
+      # transactions already imported stay.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::FeedsConnectionsDeleteBankRequest]
       # @option request_options [String] :base_url
@@ -1526,6 +1727,10 @@ module Nordlet
         end
       end
 
+      # Give exactly one of `bankAccountId` (an existing ledger bank account) or `createBankAccount` (a new one with the
+      # IBAN and currency of the feed account; `accountCode` defaults to the default bank account of the chart of
+      # accounts). `syncFrom` is the date the first sync starts from; without it the first sync covers the last 90 days.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::FeedsAccountsLinkBankRequest]
       # @option request_options [String] :base_url
@@ -1558,6 +1763,10 @@ module Nordlet
         end
       end
 
+      # `importTemplateId` must be a template of type bank_connection, or null to apply none. `syncSchedule` is manual,
+      # daily, weekly or monthly; every account whose schedule is not manual is synced by Nordlet when it is due. At
+      # least one of the two must be given.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::FeedsAccountsConfigureBankRequest]
       # @option request_options [String] :base_url
@@ -1590,6 +1799,15 @@ module Nordlet
         end
       end
 
+      # Fetches the transactions of every linked bank-feed account of the connection, or of `feedAccountId` alone, from
+      # `dateFrom` (default: seven days before the last sync, else the `syncFrom` of the account, else 90 days back) to
+      # `dateTo`, and inserts the new ones into the linked ledger bank account; lines already there count as `skipped`.
+      # An import template set on the account is applied as in `bank/statements/import`. Answers 409 when the connection
+      # is not active or has no session, and when the bank returns more than 20 pages for the range (keep `dateFrom` and
+      # set an earlier `dateTo`). A provider failure is written to the `error` of the connection, and one that is not
+      # retryable sets its status to error. The outcome is announced as `bank_feed.synced`, and invoices the template
+      # issues as `sale_invoice.issued`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Bank::Types::FeedsSyncBankRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/billing/client.rb

@@ -10,6 +10,10 @@ module Nordlet
         @client = client
       end
 
+      # Return the signed-in user's billing account: plan, account type, status, balance, trial and payment state, the
+      # month-to-date usage of the companies the user pays for with an estimate of today's charge, the plan catalogue,
+      # and the top-up, automatic top-up and overdraft settings.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::AccountGetBillingRequest]
       # @option request_options [String] :base_url
@@ -42,6 +46,9 @@ module Nordlet
         end
       end
 
+      # Change the plan of the user's flat-rate billing account; answers 409 when the account type is not `flat_rate`.
+      # With a Stripe subscription and payments configured, the subscription is moved to the new plan.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::AccountSetPlanBillingRequest]
       # @option request_options [String] :base_url
@@ -74,6 +81,11 @@ module Nordlet
         end
       end
 
+      # Switch the user's billing account between `flat_rate` and `per_request`. With a Stripe subscription and payments
+      # configured, the subscription is moved to the plan's price for `flat_rate`; for `per_request` the plan is taken
+      # off the subscription, and a subscription that carried only the plan is cancelled, leaving the account without
+      # one. When Stripe refuses the change, the previous account type is restored.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::AccountSetAccountTypeBillingRequest]
       # @option request_options [String] :base_url
@@ -106,6 +118,10 @@ module Nordlet
         end
       end
 
+      # Switch automatic top-ups on or off and set their amount. Switching them on needs a Stripe customer, which the
+      # first card top-up creates (400 otherwise); when switched on, a top-up is charged at once if the balance is at or
+      # below zero, no payment has failed and no top-up was requested in the last 24 hours.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::AccountSetAutoTopUpBillingRequest]
       # @option request_options [String] :base_url
@@ -138,6 +154,9 @@ module Nordlet
         end
       end
 
+      # Set the overdraft cap of the user's billing account: how far usage charges may take the balance below zero
+      # before the account is suspended. A suspended account whose balance is within the new cap is activated again.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::AccountSetOverdraftCapBillingRequest]
       # @option request_options [String] :base_url
@@ -170,6 +189,10 @@ module Nordlet
         end
       end
 
+      # Open a Stripe Checkout session for a one-time credit top-up of `amountCents` and return its URL; a Stripe
+      # customer is created for the user when there is none. `returnTo` chooses whether Checkout returns to the credits
+      # page or to the onboarding plan page, in `locale`. Answers 503 when online payments are not configured.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::TopupCreateBillingRequest]
       # @option request_options [String] :base_url
@@ -202,6 +225,10 @@ module Nordlet
         end
       end
 
+      # Confirm a paid top-up Checkout session by `sessionId` and credit the account at once instead of waiting for the
+      # Stripe webhook; a session is credited only once. Answers 404 when the session is not the user's own or is not
+      # paid.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::TopupConfirmBillingRequest]
       # @option request_options [String] :base_url
@@ -234,6 +261,11 @@ module Nordlet
         end
       end
 
+      # 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 or the plan has no
+      # price.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::FlatRateCreateBillingRequest]
       # @option request_options [String] :base_url
@@ -266,6 +298,10 @@ module Nordlet
         end
       end
 
+      # Confirm a completed flat-rate Checkout session by `sessionId`: the account becomes `flat_rate` on the session's
+      # plan with status `active` and the subscription attached, unless the Stripe webhook already did this. Answers 404
+      # when the session is not the user's own or not completed.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::FlatRateConfirmBillingRequest]
       # @option request_options [String] :base_url
@@ -298,6 +334,9 @@ module Nordlet
         end
       end
 
+      # Open a Stripe customer portal session that returns to the credits page in `locale`, and return its URL. Answers
+      # 503 when online payments are not configured and 400 when the user has no Stripe customer yet.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::PortalCreateBillingRequest]
       # @option request_options [String] :base_url
@@ -330,6 +369,9 @@ module Nordlet
         end
       end
 
+      # List the newest credit transactions of the user's billing account, up to `limit`: trial grants, top-ups, usage
+      # charges, activations and adjustments, each with the balance after it.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::TransactionsListBillingRequest]
       # @option request_options [String] :base_url
@@ -362,6 +404,9 @@ module Nordlet
         end
       end
 
+      # List the daily usage records of the companies the user pays for, from `from` to `to`: one row per company, date
+      # and metric (API requests, OCR pages, file storage bytes, database bytes, sale invoices).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Billing::Types::UsageListBillingRequest]
       # @option request_options [String] :base_url