nordlet 0.5.4 → 0.5.5

data/lib/nordlet/operation_types/client.rb

@@ -10,6 +10,15 @@ module Nordlet
         @client = client
       end
 
+      # Create an operation type: a `code` with the flags that say what it is for (`isSale`, `isPurchase`, ...), an
+      # optional `invoiceType` (`invoice`, `credit_note`, `proforma`, `advance`) and optional account codes. An invoice
+      # names it in `operationTypeId`: a sale invoice needs `isSale` and a matching `invoiceType`, a purchase invoice
+      # `isPurchase`, and the type's account codes then replace the default posting accounts when the invoice is issued
+      # (`sales/invoices/issue`) or registered (`purchases/invoices/register`). `includeInVatRegister: false` keeps the
+      # type's invoices out of the Lithuanian i.SAF and FR0600, `includeInSaft: false` out of the SAF-T file. Account
+      # codes must exist and be postable and `payerPartnerId` must be an active partner (422 otherwise); a repeated
+      # `code` is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::OperationTypes::Types::CreateOperationTypesRequest]
       # @option request_options [String] :base_url
@@ -42,6 +51,9 @@ module Nordlet
         end
       end
 
+      # Change an operation type's fields; omitted ones keep their value. A `code` already used by another type is
+      # refused with 409, a body without changes with 400.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::OperationTypes::Types::UpdateOperationTypesRequest]
       # @option request_options [String] :base_url
@@ -74,6 +86,8 @@ module Nordlet
         end
       end
 
+      # Read one operation type.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::OperationTypes::Types::GetOperationTypesRequest]
       # @option request_options [String] :base_url
@@ -106,6 +120,9 @@ module Nordlet
         end
       end
 
+      # Delete an operation type that no sale invoice, purchase invoice or document series refers to. Otherwise the call
+      # is refused with 409; deactivate the type with `operation-types/update` instead.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::OperationTypes::Types::DeleteOperationTypesRequest]
       # @option request_options [String] :base_url
@@ -138,6 +155,9 @@ module Nordlet
         end
       end
 
+      # List operation types. Filterable by `code`, `name`, `isSale`, `isPurchase` and `isActive`; sortable by `code`,
+      # `name`, `sortOrder` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::OperationTypes::Types::ListOperationTypesRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/partners/client.rb

@@ -10,6 +10,8 @@ module Nordlet
         @client = client
       end
 
+      # Adds an address of type billing, shipping, registered or other to the partner in `partnerId`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::AddressesCreatePartnersRequest]
       # @option request_options [String] :base_url
@@ -42,6 +44,8 @@ module Nordlet
         end
       end
 
+      # Changes the given fields of a partner address.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::AddressesUpdatePartnersRequest]
       # @option request_options [String] :base_url
@@ -74,6 +78,8 @@ module Nordlet
         end
       end
 
+      # Deletes a partner address.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::AddressesDeletePartnersRequest]
       # @option request_options [String] :base_url
@@ -106,6 +112,8 @@ module Nordlet
         end
       end
 
+      # Lists partner addresses; filterable by `partnerId`, `type` and `city`, sortable by `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::AddressesListPartnersRequest]
       # @option request_options [String] :base_url
@@ -138,6 +146,8 @@ module Nordlet
         end
       end
 
+      # Adds a contact person to the partner in `partnerId`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::ContactsCreatePartnersRequest]
       # @option request_options [String] :base_url
@@ -170,6 +180,8 @@ module Nordlet
         end
       end
 
+      # Changes the given fields of a partner contact.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::ContactsUpdatePartnersRequest]
       # @option request_options [String] :base_url
@@ -202,6 +214,8 @@ module Nordlet
         end
       end
 
+      # Deletes a partner contact.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::ContactsDeletePartnersRequest]
       # @option request_options [String] :base_url
@@ -234,6 +248,8 @@ module Nordlet
         end
       end
 
+      # Lists partner contacts; filterable by `partnerId`, `name` and `email`, sortable by `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::ContactsListPartnersRequest]
       # @option request_options [String] :base_url
@@ -266,6 +282,10 @@ module Nordlet
         end
       end
 
+      # Adds a bank account to the partner in `partnerId`. The IBAN is stored without spaces in upper case; an IBAN the
+      # partner already has is refused with 409. With `isDefault` true the partner's other accounts lose their default
+      # mark.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::BankAccountsCreatePartnersRequest]
       # @option request_options [String] :base_url
@@ -298,6 +318,10 @@ module Nordlet
         end
       end
 
+      # Changes the given fields of a partner bank account. A new IBAN is stored without spaces in upper case and is
+      # refused with 409 when the partner already has it; when the account is the default after the change, the
+      # partner's other accounts lose their default mark.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::BankAccountsUpdatePartnersRequest]
       # @option request_options [String] :base_url
@@ -330,6 +354,8 @@ module Nordlet
         end
       end
 
+      # Deletes a partner bank account.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::BankAccountsDeletePartnersRequest]
       # @option request_options [String] :base_url
@@ -362,6 +388,8 @@ module Nordlet
         end
       end
 
+      # Lists partner bank accounts; filterable by `partnerId` and `iban`, sortable by `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::BankAccountsListPartnersRequest]
       # @option request_options [String] :base_url
@@ -394,6 +422,9 @@ module Nordlet
         end
       end
 
+      # Lists the files attached to a partner, newest first. `partners/create` attaches one with `documentRef`, and
+      # `leads/convert` moves the lead's files here.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::FilesListPartnersRequest]
       # @option request_options [String] :base_url
@@ -426,6 +457,13 @@ module Nordlet
         end
       end
 
+      # Runs the selection of the daily debt-reminder job for this company as of the company's current date and returns
+      # what 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 reminder in the last 7 days and has issued invoices or advance invoices
+      # past their due date with an unpaid remainder; the interest per invoice is the remainder times the partner's
+      # `lateInterestPercent` times the days late over 365, and the totals are per currency. Sent reminders are listed
+      # by `partners/debt-reminders/list`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::DebtRemindersPreviewPartnersRequest]
       # @option request_options [String] :base_url
@@ -458,6 +496,9 @@ module Nordlet
         end
       end
 
+      # 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`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::DebtRemindersListPartnersRequest]
       # @option request_options [String] :base_url
@@ -490,6 +531,14 @@ module Nordlet
         end
       end
 
+      # 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`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::ValidateVatPartnersRequest]
       # @option request_options [String] :base_url
@@ -522,6 +571,9 @@ module Nordlet
         end
       end
 
+      # 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`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::VatReviewsListPartnersRequest]
       # @option request_options [String] :base_url
@@ -554,6 +606,11 @@ module Nordlet
         end
       end
 
+      # 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`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::VatReviewsResolvePartnersRequest]
       # @option request_options [String] :base_url
@@ -586,6 +643,14 @@ module Nordlet
         end
       end
 
+      # 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`).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::CreatePartnersRequest]
       # @option request_options [String] :base_url
@@ -618,6 +683,10 @@ module Nordlet
         end
       end
 
+      # 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.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::FindOrCreatePartnersRequest]
       # @option request_options [String] :base_url
@@ -650,6 +719,8 @@ module Nordlet
         end
       end
 
+      # Returns one partner; a deleted partner answers 404.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::GetPartnersRequest]
       # @option request_options [String] :base_url
@@ -682,6 +753,12 @@ module Nordlet
         end
       end
 
+      # 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`).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::UpdatePartnersRequest]
       # @option request_options [String] :base_url
@@ -714,6 +791,8 @@ module Nordlet
         end
       end
 
+      # Marks a partner as deleted; it no longer appears in lists or lookups.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::DeletePartnersRequest]
       # @option request_options [String] :base_url
@@ -746,6 +825,13 @@ module Nordlet
         end
       end
 
+      # 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`).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::MergePartnersRequest]
       # @option request_options [String] :base_url
@@ -814,6 +900,10 @@ module Nordlet
         end
       end
 
+      # 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`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::ListPartnersRequest]
       # @option request_options [String] :base_url
@@ -846,6 +936,8 @@ module Nordlet
         end
       end
 
+      # Creates a partner group; a `code` already used by a group of the company is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::GroupsCreatePartnersRequest]
       # @option request_options [String] :base_url
@@ -878,6 +970,9 @@ module Nordlet
         end
       end
 
+      # Changes the code or name of a partner group; a code already used by another group of the company is refused with
+      # 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::GroupsUpdatePartnersRequest]
       # @option request_options [String] :base_url
@@ -910,6 +1005,8 @@ module Nordlet
         end
       end
 
+      # Deletes a partner group; a group still assigned to a live partner is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::GroupsDeletePartnersRequest]
       # @option request_options [String] :base_url
@@ -942,6 +1039,8 @@ module Nordlet
         end
       end
 
+      # Lists the company's partner groups ordered by code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::GroupsListPartnersRequest]
       # @option request_options [String] :base_url
@@ -974,6 +1073,9 @@ module Nordlet
         end
       end
 
+      # Creates a partner status with a `sortOrder`; a `code` already used by a status of the company is refused with
+      # 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::StatusesCreatePartnersRequest]
       # @option request_options [String] :base_url
@@ -1006,6 +1108,9 @@ module Nordlet
         end
       end
 
+      # 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.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::StatusesUpdatePartnersRequest]
       # @option request_options [String] :base_url
@@ -1038,6 +1143,8 @@ module Nordlet
         end
       end
 
+      # Deletes a partner status; a status still assigned to a live partner is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::StatusesDeletePartnersRequest]
       # @option request_options [String] :base_url
@@ -1070,6 +1177,8 @@ module Nordlet
         end
       end
 
+      # Lists the company's partner statuses ordered by sort order, then code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::StatusesListPartnersRequest]
       # @option request_options [String] :base_url
@@ -1102,6 +1211,10 @@ module Nordlet
         end
       end
 
+      # 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`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::InquiriesCreatePartnersRequest]
       # @option request_options [String] :base_url
@@ -1134,6 +1247,9 @@ module Nordlet
         end
       end
 
+      # 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.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::InquiriesUpdatePartnersRequest]
       # @option request_options [String] :base_url
@@ -1166,6 +1282,8 @@ module Nordlet
         end
       end
 
+      # Returns one inquiry with the name of its partner.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::InquiriesGetPartnersRequest]
       # @option request_options [String] :base_url
@@ -1198,6 +1316,9 @@ module Nordlet
         end
       end
 
+      # Lists inquiries with their partner names; filterable by `status`, `channel`, `partnerId`, `assignedUserId` and
+      # `subject`, sortable by `createdAt` and `updatedAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::InquiriesListPartnersRequest]
       # @option request_options [String] :base_url
@@ -1230,6 +1351,11 @@ module Nordlet
         end
       end
 
+      # Compares a partner's open receivables plus an optional `additionalAmount` with its `creditLimit`. The open
+      # receivables are the unpaid remainder of the partner's issued invoices, advance invoices and credit notes (credit
+      # notes negative), converted to the company's base currency at each invoice's `fxRate`. Without a credit limit
+      # `available` is null and `exceeded` is false.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Partners::Types::CreditCheckPartnersRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/payroll/client.rb

@@ -10,6 +10,8 @@ module Nordlet
         @client = client
       end
 
+      # Creates a department with a code and a name; answers 409 when the code already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::DepartmentsCreatePayrollRequest]
       # @option request_options [String] :base_url
@@ -42,6 +44,8 @@ module Nordlet
         end
       end
 
+      # Lists the company's departments ordered by code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::DepartmentsListPayrollRequest]
       # @option request_options [String] :base_url
@@ -74,6 +78,9 @@ module Nordlet
         end
       end
 
+      # Creates a work schedule with a code, a name and `hoursPerWeek` (default 40); answers 409 when the code already
+      # exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::SchedulesCreatePayrollRequest]
       # @option request_options [String] :base_url
@@ -106,6 +113,8 @@ module Nordlet
         end
       end
 
+      # Lists the company's work schedules ordered by code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::SchedulesListPayrollRequest]
       # @option request_options [String] :base_url
@@ -138,6 +147,11 @@ module Nordlet
         end
       end
 
+      # Reads the payment types of the company country's payroll engine, each with the labels of the taxes,
+      # contributions and reporting lines it is subject to (`applies`), and the default type an untyped payment falls
+      # under. These codes are what `payroll/calc` and the additions of `payroll/runs/create` accept as `paymentType`.
+      # Answers 422 when Nordlet has no payroll engine for the company's country.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::PaymentTypesListPayrollRequest]
       # @option request_options [String] :base_url
@@ -170,6 +184,12 @@ module Nordlet
         end
       end
 
+      # Runs the company country's payroll engine once on a taxable base at a date, with the employee settings given in
+      # the body instead of an employee record, and returns the allowance, income tax, contributions, components and
+      # net; nothing is saved. `payments` passes typed payments to the engine; each `paymentType` must be a code from
+      # `payroll/payment-types/list` (422 otherwise). Answers 422 when Nordlet has no payroll engine for the company's
+      # country.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::CalcPayrollRequest]
       # @option request_options [String] :base_url
@@ -202,6 +222,18 @@ module Nordlet
         end
       end
 
+      # Creates a draft payroll run for a month, computing each line with the company country's payroll engine, the
+      # employee's approved runs of the year so far and of the two previous years, the month's timesheet and `payDate`
+      # (default the last day of the month). Without `lines`, every active employee whose contract covers the month gets
+      # a line: the gross is the contract's monthly salary reduced to the paid working days of the contract and the
+      # timesheet, unless `grossOverrides` sets it; the per diems of approved business trips ending in the month are
+      # added untaxed and the trips linked to the run; for a Lithuanian company the car benefit in kind
+      # (`includeNatura`) and the compensation for unused leave of a contract ending in the month are added. With
+      # `lines`, only the given employees are computed with their gross, additions and deductions; a taxable addition
+      # may carry a `paymentType` from `payroll/payment-types/list` and `hours`. Answers 422 when the country has no
+      # engine, an employee is given twice, has two contracts in the month, has no contract and no gross, or is paid by
+      # the hour or day without a gross; 409 when a run for the month already exists or the accounting period is locked.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::RunsCreatePayrollRequest]
       # @option request_options [String] :base_url
@@ -234,6 +266,8 @@ module Nordlet
         end
       end
 
+      # Reads a payroll run with its lines.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::RunsGetPayrollRequest]
       # @option request_options [String] :base_url
@@ -266,6 +300,9 @@ module Nordlet
         end
       end
 
+      # Lists payroll runs without their lines; filterable by `status`, `year` and `month`, sortable by `createdAt`,
+      # `year` and `month`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::RunsListPayrollRequest]
       # @option request_options [String] :base_url
@@ -333,6 +370,16 @@ module Nordlet
         end
       end
 
+      # Posts the run's journal entry dated the last day of the month and sets the status to `approved`: the wage
+      # expense (net pay, income tax, employee contributions and deductions) and the employer contributions are debited;
+      # the net payable, the income tax, the social contributions (on one account, or split between the employee and
+      # employer accounts when their codes differ) and the deductions are credited. The accounts default to the payroll
+      # accounts of the company's chart template; each can be given per call. Answers 409 when the run is not a draft or
+      # the accounting period is locked, 422 when the run has no lines or nothing to post, and emits
+      # `payroll_run.approved`. For an Irish company with the automation of the `ie-payroll-withholding` deadline
+      # switched on, the month's payroll submission is sent at once and a failure is added to the run's `warnings`. Undo
+      # with `payroll/runs/reverse`, pay with `payroll/payments/export`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::RunsApprovePayrollRequest]
       # @option request_options [String] :base_url
@@ -365,6 +412,11 @@ module Nordlet
         end
       end
 
+      # Posts a journal entry dated the last day of the month that mirrors the run's entry (debits and credits swapped),
+      # sets the status to `reversed` with the reason, and releases the business trips the run paid so the next run
+      # picks them up again. Answers 409 when the run is not approved, when part of it is matched to bank payments
+      # (`paidAmount`, unmatch them first) or when the accounting period is locked. Emits `payroll_run.reversed`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::RunsReversePayrollRequest]
       # @option request_options [String] :base_url
@@ -397,6 +449,9 @@ module Nordlet
         end
       end
 
+      # Deletes a draft run with its lines and releases the business trips linked to it; answers 409 when the run is not
+      # a draft. An approved run is undone with `payroll/runs/reverse`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::RunsCancelPayrollRequest]
       # @option request_options [String] :base_url
@@ -429,6 +484,13 @@ module Nordlet
         end
       end
 
+      # Builds a SEPA credit transfer file (pain.001.001.03) for an approved run: one transfer from the chosen bank
+      # account to each employee's IBAN for the line's net when it is positive, with a remittance text in `locale`
+      # (default the locale of the calling user) and the run period, executed on `executionDate` (default the company's
+      # current date). Answers 409 when the run is not approved, and 422 when the bank account has no IBAN or is not in
+      # the company's base currency, an employee has no IBAN (`hr/employees/update`) or no line has a positive net. The
+      # file is returned in `xml`; nothing is sent to the bank.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Payroll::Types::PaymentsExportPayrollRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/peppol/client.rb

@@ -46,6 +46,13 @@ module Nordlet
         end
       end
 
+      # Apply one event: a delivery status event updates the Peppol status of the sale invoice with that message id and,
+      # when the status changes, emits `sale_invoice.peppol_delivered`, `sale_invoice.peppol_rejected` or
+      # `sale_invoice.peppol_failed`; a received-document event fetches the document from the access point, stores it as
+      # a document capture with the matched supplier, emits `document_capture.peppol_received` and marks it read at the
+      # access point (a document already stored is skipped). `handled` is false when the event matched no invoice or
+      # document. Answers 404 when no company uses that provider account, 401 when the signature does not match.
+      #
       # @param request_options [Hash]
       # @param params [Hash]
       # @option request_options [String] :base_url

data/lib/nordlet/platform_sellers/client.rb

@@ -45,6 +45,8 @@ module Nordlet
         end
       end
 
+      # Read one platform seller with its activities, ordered by year.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::PlatformSellers::Types::GetPlatformSellersRequest]
       # @option request_options [String] :base_url
@@ -77,6 +79,12 @@ module Nordlet
         end
       end
 
+      # Record a seller on the company's platform for the DAC7 report: an `individual` (first and last name required) or
+      # an `entity` (`entityName` required), with its `activities` per year and quarter. An `immovable_property`
+      # activity needs `propertyAddress`; property address, type and rented days on any other kind of activity are
+      # refused. These checks answer 422; a `partnerId` that does not exist answers 404. The report is built from the
+      # sellers with `declarations/eu/dac7/preview` and `declarations/eu/dac7/xml`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::PlatformSellers::Types::CreatePlatformSellersRequest]
       # @option request_options [String] :base_url
@@ -109,6 +117,9 @@ module Nordlet
         end
       end
 
+      # Replace a platform seller's details and all of its activities with the ones given, under the same checks as
+      # `platform-sellers/create`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::PlatformSellers::Types::UpdatePlatformSellersRequest]
       # @option request_options [String] :base_url
@@ -141,6 +152,8 @@ module Nordlet
         end
       end
 
+      # Mark a platform seller as deleted. It leaves the lists and the DAC7 report.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::PlatformSellers::Types::DeletePlatformSellersRequest]
       # @option request_options [String] :base_url