nordlet 0.5.4 → 0.5.6

data/lib/nordlet/partners/types/debt_reminders_upcoming_partners_response_rows_item_kind.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Partners
+    module Types
+      module DebtRemindersUpcomingPartnersResponseRowsItemKind
+        extend Nordlet::Internal::Types::Enum
+
+        BEFORE_DUE = "before_due"
+        OVERDUE = "overdue"
+      end
+    end
+  end
+end

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

data/lib/nordlet/pos/client.rb

@@ -10,6 +10,9 @@ module Nordlet
         @client = client
       end
 
+      # Register a cash register (POS device). The serial number must be unique in the company; a repeat is refused with
+      # 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::DevicesCreatePosRequest]
       # @option request_options [String] :base_url
@@ -42,6 +45,9 @@ module Nordlet
         end
       end
 
+      # Change a POS device's details or set `isActive`; an inactive device accepts no new shifts or reports. A serial
+      # number already used by another device is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::DevicesUpdatePosRequest]
       # @option request_options [String] :base_url
@@ -74,6 +80,8 @@ module Nordlet
         end
       end
 
+      # List POS devices. Filterable by `name` and `serialNumber`; sortable by `name`, `serialNumber` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::DevicesListPosRequest]
       # @option request_options [String] :base_url
@@ -106,6 +114,15 @@ module Nordlet
         end
       end
 
+      # Record a daily cash register report (Z-report) and post it to the ledger in one journal entry: the cash and card
+      # takings are debited to `cashAccountCode` and `cardAccountCode`, the net of the `vatLines` is credited to
+      # `revenueAccountCode` and their VAT to `vatAccountCode`. `itemLines` write the sold products off `warehouseId`
+      # FIFO (a set is expanded to its product components) and add the cost of goods sold, debited to `cogsAccountCode`
+      # against the stock accounts. Account codes default to the company's chart. Refused with 422 when cash plus card
+      # differs from the gross total, the item lines have no warehouse or the device is inactive, with 409 when the
+      # accounting period is locked or the `reportNumber` already exists. Emits `pos_report.created` and, per item line,
+      # `stock.changed`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ReportsCreatePosRequest]
       # @option request_options [String] :base_url
@@ -138,6 +155,8 @@ module Nordlet
         end
       end
 
+      # Read one POS report with its VAT lines.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ReportsGetPosRequest]
       # @option request_options [String] :base_url
@@ -170,6 +189,9 @@ module Nordlet
         end
       end
 
+      # List POS reports without their VAT lines. Filterable by `date`, `reportNumber` and `deviceId`; sortable by
+      # `date`, `reportNumber` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ReportsListPosRequest]
       # @option request_options [String] :base_url
@@ -202,6 +224,10 @@ module Nordlet
         end
       end
 
+      # Open a shift on a POS device with the cash float `openingCash`. A device has at most one open shift (409 for a
+      # second); an inactive device is refused with 422. Give `warehouseId` when the shift will sell stock items; they
+      # are written off that warehouse when the shift is closed.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ShiftsOpenPosRequest]
       # @option request_options [String] :base_url
@@ -234,6 +260,8 @@ module Nordlet
         end
       end
 
+      # Read one POS shift.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ShiftsGetPosRequest]
       # @option request_options [String] :base_url
@@ -266,6 +294,8 @@ module Nordlet
         end
       end
 
+      # List POS shifts. Filterable by `deviceId` and `status`; sortable by `openedAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ShiftsListPosRequest]
       # @option request_options [String] :base_url
@@ -298,6 +328,11 @@ module Nordlet
         end
       end
 
+      # Record a receipt in an open shift, numbered per shift from 1. Each line's net, VAT and gross come from its
+      # VAT-inclusive unit price; a line without `description` takes its item's name. Refused with 422 when cash plus
+      # card differs from the receipt total or a stock item is sold in a shift opened without a warehouse, with 409 when
+      # the shift is closed.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ReceiptsCreatePosRequest]
       # @option request_options [String] :base_url
@@ -330,6 +365,8 @@ module Nordlet
         end
       end
 
+      # List receipts without their lines. Filterable by `shiftId`; sortable by `number` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ReceiptsListPosRequest]
       # @option request_options [String] :base_url
@@ -362,6 +399,8 @@ module Nordlet
         end
       end
 
+      # Read one receipt with its lines.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ReceiptsGetPosRequest]
       # @option request_options [String] :base_url
@@ -394,6 +433,13 @@ module Nordlet
         end
       end
 
+      # Close an open shift: its receipts are summed by VAT rate and by product into one POS report, created as by
+      # `pos/reports/create` with number `reportNumber` (default `Z-<device serial>-<n>`, n being the device's closed
+      # shifts plus one) on `date` (default: the company's today), which posts the takings and the stock write-off to
+      # the ledger and emits `pos_report.created`. The response adds `expectedCash` (opening cash plus the cash
+      # receipts) and `cashDifference` (`countedCash` less expected). A shift without receipts is refused with 422, a
+      # closed one with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Pos::Types::ShiftsClosePosRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/production/client.rb

@@ -10,6 +10,10 @@ module Nordlet
         @client = client
       end
 
+      # Create a work center with its `costPerHour`. `costAccountCode` must be a postable account of the chart (422
+      # otherwise); when a production order completes, the labor cost of the operations run on this center is credited
+      # to it instead of the `production.laborApplied` posting rule account. A duplicate `code` is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::WorkCentersCreateProductionRequest]
       # @option request_options [String] :base_url
@@ -42,6 +46,9 @@ module Nordlet
         end
       end
 
+      # Change a work center; only the fields sent are changed. `costAccountCode` must be a postable account of the
+      # chart (422 otherwise); a `code` already used by another work center is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::WorkCentersUpdateProductionRequest]
       # @option request_options [String] :base_url
@@ -74,6 +81,10 @@ module Nordlet
         end
       end
 
+      # List work centers. `nextMaintenanceDate` is the latest completed maintenance date (the creation date when there
+      # is none) plus `maintenanceIntervalDays`, null without an interval. Filterable by `code`, `name` and `isActive`;
+      # sortable by `code`, `name` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::WorkCentersListProductionRequest]
       # @option request_options [String] :base_url
@@ -106,6 +117,10 @@ module Nordlet
         end
       end
 
+      # Create a routing with its operations: `sequence`, work center, `setupMinutes`, `runMinutesPerUnit` and an
+      # optional `qualityCheckName` that becomes a pending quality check on every production order using the routing.
+      # Operation sequences must be unique (422); a duplicate `code` is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::RoutingsCreateProductionRequest]
       # @option request_options [String] :base_url
@@ -138,6 +153,8 @@ module Nordlet
         end
       end
 
+      # Return one routing with its operations in sequence order.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::RoutingsGetProductionRequest]
       # @option request_options [String] :base_url
@@ -170,6 +187,9 @@ module Nordlet
         end
       end
 
+      # List routings without their operations. Filterable by `code`, `name` and `isActive`; sortable by `code`, `name`
+      # and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::RoutingsListProductionRequest]
       # @option request_options [String] :base_url
@@ -202,6 +222,9 @@ module Nordlet
         end
       end
 
+      # Record a `preventive` or `corrective` maintenance planned for a work center on `plannedDate`; it starts as
+      # `planned`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::MaintenanceCreateProductionRequest]
       # @option request_options [String] :base_url
@@ -234,6 +257,10 @@ module Nordlet
         end
       end
 
+      # Mark a `planned` maintenance as completed on `completedDate`, with optional `downtimeHours` and `cost` (409 when
+      # it is already completed or cancelled). The work center's `nextMaintenanceDate` is then counted from the latest
+      # completed maintenance date.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::MaintenanceCompleteProductionRequest]
       # @option request_options [String] :base_url
@@ -266,6 +293,8 @@ module Nordlet
         end
       end
 
+      # Cancel a `planned` maintenance (409 when it is already completed or cancelled).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::MaintenanceCancelProductionRequest]
       # @option request_options [String] :base_url
@@ -298,6 +327,9 @@ module Nordlet
         end
       end
 
+      # List maintenance records. Filterable by `workCenterId`, `status` and `type`; sortable by `plannedDate` and
+      # `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::MaintenanceListProductionRequest]
       # @option request_options [String] :base_url
@@ -330,6 +362,11 @@ module Nordlet
         end
       end
 
+      # Create a bill of materials for a finished item. `outputQuantity` is the finished quantity made per unit of order
+      # quantity; each line's `quantity` is the component consumed per unit of order quantity, increased by its
+      # `scrapPercent` at completion; `routingId` is the default routing of assembly orders. A BOM that consumes its own
+      # finished item is refused with 422, a duplicate `code` with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::BomsCreateProductionRequest]
       # @option request_options [String] :base_url
@@ -362,6 +399,8 @@ module Nordlet
         end
       end
 
+      # Return one bill of materials with its component lines.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::BomsGetProductionRequest]
       # @option request_options [String] :base_url
@@ -394,6 +433,9 @@ module Nordlet
         end
       end
 
+      # List bills of materials without their lines. Filterable by `code`, `name`, `finishedItemId` and `isActive`;
+      # sortable by `code` and `name`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::BomsListProductionRequest]
       # @option request_options [String] :base_url
@@ -426,6 +468,13 @@ module Nordlet
         end
       end
 
+      # Create a draft production order for `quantity` units of a BOM in a warehouse; stock moves only at
+      # `production/orders/complete`. An `assembly` order takes its routing from `routingId`, else from the BOM, and
+      # copies the routing's operations onto the order (`plannedMinutes` = setup minutes + run minutes per unit ×
+      # finished quantity, priced at the work center's current `costPerHour`) with a pending quality check for every
+      # operation that names one. A `routingId` on a `disassembly` order, an inactive routing or a routing without
+      # operations is refused with 422.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::OrdersCreateProductionRequest]
       # @option request_options [String] :base_url
@@ -458,6 +507,9 @@ module Nordlet
         end
       end
 
+      # Record the `actualMinutes` spent on one operation of a draft production order; at completion the actual minutes,
+      # else the planned ones, price the operation's labor cost. Refused with 409 once the order is completed.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::OrdersRecordOperationProductionRequest]
       # @option request_options [String] :base_url
@@ -490,6 +542,9 @@ module Nordlet
         end
       end
 
+      # Add a pending quality check to a draft production order (409 once the order is completed). The order cannot
+      # complete while a check is pending.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::QualityChecksAddProductionRequest]
       # @option request_options [String] :base_url
@@ -522,6 +577,9 @@ module Nordlet
         end
       end
 
+      # Record the result of a quality check as `passed` or `failed`, with the time and the actor (409 once the order is
+      # completed). Only a `pending` check blocks `production/orders/complete`; a `failed` one does not.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::QualityChecksRecordProductionRequest]
       # @option request_options [String] :base_url
@@ -554,6 +612,8 @@ module Nordlet
         end
       end
 
+      # List quality checks. Filterable by `orderId`, `result` and `name`; sortable by `createdAt` and `name`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::QualityChecksListProductionRequest]
       # @option request_options [String] :base_url
@@ -586,6 +646,19 @@ module Nordlet
         end
       end
 
+      # Complete a draft production order on the order's date. An `assembly` consumes the components FIFO from the
+      # warehouse (line quantity × order quantity, increased by `scrapPercent`), prices each operation at its actual or
+      # planned minutes × `costPerHour`, receives the finished item at material cost + labor cost less the share of
+      # `scrappedQuantity`, and, when there is labor, scrap or a component stock account other than the finished one,
+      # posts a journal entry debiting the finished stock account (and the `production.scrap` rule account for the
+      # scrapped share) and crediting the component stock accounts and the work centers' cost accounts (or the
+      # `production.laborApplied` rule account); a `disassembly` consumes the finished item and receives the components
+      # at its cost shared by quantity. `componentsAccountCode` and `finishedAccountCode` default to the chart's
+      # production accounts. Refused with 409 when the order is already completed, a quality check is still pending or
+      # the accounting period is locked, and with 422 when the BOM has no lines, `scrappedQuantity` is given on a
+      # disassembly or exceeds the finished quantity, the assembly cost is zero, stock is insufficient, a received item
+      # needs lot or serial tracking, or a posting account is missing. Emits `stock.changed`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::OrdersCompleteProductionRequest]
       # @option request_options [String] :base_url
@@ -618,6 +691,8 @@ module Nordlet
         end
       end
 
+      # Return one production order with its operations and quality checks.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::OrdersGetProductionRequest]
       # @option request_options [String] :base_url
@@ -650,6 +725,9 @@ module Nordlet
         end
       end
 
+      # List production orders without operations and quality checks. Filterable by `bomId`, `warehouseId`, `status` and
+      # `type`; sortable by `date` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Production::Types::OrdersListProductionRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/projects/client.rb

@@ -10,6 +10,9 @@ module Nordlet
         @client = client
       end
 
+      # Create a project; `partnerId` is the customer that `projects/time-entries/bill` invoices by default. A duplicate
+      # `code` is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::CreateProjectsRequest]
       # @option request_options [String] :base_url
@@ -42,6 +45,9 @@ module Nordlet
         end
       end
 
+      # Change a project's name, customer, `status` (`active`, `completed`, `archived`) or notes; only the fields sent
+      # are changed. An archived project accepts no new time entries.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::UpdateProjectsRequest]
       # @option request_options [String] :base_url
@@ -74,6 +80,8 @@ module Nordlet
         end
       end
 
+      # Return one project.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::GetProjectsRequest]
       # @option request_options [String] :base_url
@@ -106,6 +114,9 @@ module Nordlet
         end
       end
 
+      # List projects. Filterable by `code`, `name`, `status` and `partnerId`; sortable by `code`, `name` and
+      # `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::ListProjectsRequest]
       # @option request_options [String] :base_url
@@ -138,6 +149,9 @@ module Nordlet
         end
       end
 
+      # Record hours worked on a project on a date, optionally for an employee and with the `hourlyRate` used when
+      # billing. `hours` must be positive (422); an archived project is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::TimeEntriesCreateProjectsRequest]
       # @option request_options [String] :base_url
@@ -170,6 +184,9 @@ module Nordlet
         end
       end
 
+      # Change a time entry; only the fields sent are changed. `hours` must be positive (422); an entry already billed
+      # to an invoice cannot be changed (409).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::TimeEntriesUpdateProjectsRequest]
       # @option request_options [String] :base_url
@@ -202,6 +219,8 @@ module Nordlet
         end
       end
 
+      # Delete a time entry (409 once it is billed).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::TimeEntriesDeleteProjectsRequest]
       # @option request_options [String] :base_url
@@ -234,6 +253,9 @@ module Nordlet
         end
       end
 
+      # List time entries. Filterable by `projectId`, `employeeId`, `billable`, `billedInvoiceId` and `date`; sortable
+      # by `date`, `createdAt` and `hours`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::TimeEntriesListProjectsRequest]
       # @option request_options [String] :base_url
@@ -266,6 +288,13 @@ module Nordlet
         end
       end
 
+      # Create a draft sale invoice from the project's unbilled billable time entries, optionally limited to `dateFrom`
+      # and `dateTo`, and mark them billed; needs the `sales:write` scope, and the invoice is issued with
+      # `sales/invoices/issue`. The customer is `partnerId`, else the project's partner (422 without either); each entry
+      # is priced at its own `hourlyRate`, else the call's `hourlyRate` (422 when an entry has neither); `groupBy`
+      # `rate` makes one line per rate with the summed hours, `entry` one line per entry; `itemId`, `vatRatePercent` and
+      # `vatClassifierCode` go onto every line. No matching entries is 422.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::TimeEntriesBillProjectsRequest]
       # @option request_options [String] :base_url
@@ -298,6 +327,12 @@ module Nordlet
         end
       end
 
+      # Profitability per project: `revenue` and `costs` from posted journal entries tagged with the project (income
+      # accounts credit less debit, expense accounts debit less credit), `profit` as their difference, and the hours
+      # from time entries (total, billable, billed, unbilled, and the unbilled amount at the entries' hourly rates).
+      # `projectId` limits the report to one project; `dateFrom` and `dateTo` limit the journal dates and the entry
+      # dates. Nothing is changed.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Projects::Types::ReportProjectsRequest]
       # @option request_options [String] :base_url