nordlet 0.5.4 → 0.5.6

data/lib/nordlet/public/client.rb

@@ -10,6 +10,9 @@ module Nordlet
         @client = client
       end
 
+      # Store a request for an integration: the integration asked for and the sender's name, company, e-mail and
+      # details. When `website` is filled in, the call answers `received` without storing anything.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Public::Types::IntegrationRequestsPublicRequest]
       # @option request_options [String] :base_url
@@ -42,6 +45,12 @@ module Nordlet
         end
       end
 
+      # Redirect (302) to the company's payment page for the issued invoice that carries this payment token, rendered
+      # from the template set with `sales/invoices/payment-settings/update` with the invoice number, the amount still
+      # unpaid, the currency, the token, the invoice id and the customer name (see `sales/invoices/payment-link`).
+      # Answers 404 when the token matches no issued invoice or the company has no template, and 409 when the invoice is
+      # already paid.
+      #
       # @param request_options [Hash]
       # @param params [Hash]
       # @option request_options [String] :base_url

data/lib/nordlet/purchases/client.rb

@@ -10,6 +10,14 @@ module Nordlet
         @client = client
       end
 
+      # Create a draft purchase invoice or credit note (`type`) from a supplier document; it is posted with
+      # `purchases/invoices/register`. Lines without a unit price take the item's supplier or purchase price, `currency`
+      # defaults to the company's invoice currency, `documentRef` links an uploaded file, and the gross total leaves out
+      # self-assessed VAT. `creditedInvoiceId` (credit notes only) must be an invoice of the same partner,
+      # `purchaseOrderId` an order of the same partner that is not draft, submitted or cancelled, and `operationTypeId`
+      # an active purchase operation type, each 422 otherwise; the same `documentNumber` for the same partner is refused
+      # with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::InvoicesCreatePurchasesRequest]
       # @option request_options [String] :base_url
@@ -42,6 +50,8 @@ module Nordlet
         end
       end
 
+      # Return one purchase invoice or credit note with its lines.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::InvoicesGetPurchasesRequest]
       # @option request_options [String] :base_url
@@ -74,6 +84,10 @@ module Nordlet
         end
       end
 
+      # Change a draft purchase invoice (409 once registered); only the fields sent are changed, and `lines` replace all
+      # existing lines with the totals recomputed. `purchaseOrderId` and `operationTypeId` are checked as on
+      # `purchases/invoices/create` (422). A `documentNumber` already used for the partner is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::InvoicesUpdatePurchasesRequest]
       # @option request_options [String] :base_url
@@ -106,6 +120,9 @@ module Nordlet
         end
       end
 
+      # Mark a draft purchase invoice as deleted (409 once registered). A document capture linked to it goes back to
+      # `extracted` (or `pending` when it has no extraction) and can be confirmed again.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::InvoicesDeletePurchasesRequest]
       # @option request_options [String] :base_url
@@ -138,6 +155,24 @@ module Nordlet
         end
       end
 
+      # Register a draft purchase invoice or credit note: posts the journal entry dated `registrationDate` (default the
+      # document date) and sets the status to `registered`. The entry debits each line's expense account (the line's
+      # `accountCode`, else the item's purchase or expense account, else the operation type's expense account, else the
+      # `purchases.goodsForResale` or `purchases.defaultExpense` rule account), debits VAT receivable (a company that is
+      # not a VAT payer books the VAT into the expense instead), credits payables (the operation type's credit account
+      # when set) and credits output VAT for self-assessed VAT; a credit note posts the reverse. Lines with
+      # `deferralStartDate` and `deferralEndDate` are debited to the `purchases.prepaidExpenses` account instead and get
+      # a monthly release schedule for `purchases/deferrals/post`. With `warehouseId` the product lines of an invoice
+      # are received into stock at their base-currency cost (422 on an order-linked invoice, whose goods arrive through
+      # `purchases/receipts/create`, and for a line that is also deferred); `returnFromStock` on a credit note that
+      # credits an invoice takes the goods back out of stock at their FIFO cost and books the difference to the credited
+      # amount on the `inventory.cogs` account (422 on an invoice, without `creditedInvoiceId`, or when no goods of the
+      # credited invoice are in stock). A credit note that credits a registered invoice in the same currency is applied
+      # to it as a payment up to the open amount. Refused with 409 when already registered or the accounting period is
+      # locked, and with 422 when the credit notes would exceed the credited invoice, a posting account is missing or no
+      # exchange rate exists for the date. Emits `purchase_invoice.registered`, `purchase_invoice.paid` when the
+      # credited invoice becomes fully paid, and `stock.changed` when stock moves.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::InvoicesRegisterPurchasesRequest]
       # @option request_options [String] :base_url
@@ -170,6 +205,10 @@ module Nordlet
         end
       end
 
+      # List the monthly release rows that `purchases/invoices/register` creates for lines booked as prepaid expenses,
+      # each with its amount, expense and prepaid account and `status` (`pending`, `posted`, `cancelled`). Filterable by
+      # `invoiceId`, `status` and `scheduleDate`; sortable by `scheduleDate`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::DeferralsListPurchasesRequest]
       # @option request_options [String] :base_url
@@ -202,6 +241,11 @@ module Nordlet
         end
       end
 
+      # Post every `pending` prepaid-expense release row dated on or before `asOfDate` (default today in the company's
+      # time zone): one journal entry per schedule date debiting the expense account and crediting the prepaid account,
+      # and the rows become `posted`. A locked accounting period is refused with 409. The scheduled job
+      # `expense-deferrals` runs the same release for every active company.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::DeferralsPostPurchasesRequest]
       # @option request_options [String] :base_url
@@ -234,6 +278,11 @@ module Nordlet
         end
       end
 
+      # List purchase invoices and credit notes without lines, with the supplier's `partnerName`. Filterable by
+      # `partnerId`, `type`, `status`, `paymentStatus`, `documentNumber`, `documentDate`, `currency`, `operationTypeId`,
+      # `purchaseOrderId`, `grossTotal`, `netTotal`, `vatTotal` and `dueDate`; sortable by `createdAt`, `documentDate`,
+      # `documentNumber`, `grossTotal` and `dueDate`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::InvoicesListPurchasesRequest]
       # @option request_options [String] :base_url
@@ -266,6 +315,12 @@ module Nordlet
         end
       end
 
+      # Create a draft purchase order for a supplier. Lines without a unit price take the item's supplier or purchase
+      # price; `orderNumber` comes from the `purchase_order` series with prefix PO when not given; `currency` defaults
+      # to the company's invoice currency; `documentRef` links an uploaded file to the order. A number already in use is
+      # refused with 409. The order continues with `purchases/orders/submit`, `purchases/orders/approve` and
+      # `purchases/receipts/create`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersCreatePurchasesRequest]
       # @option request_options [String] :base_url
@@ -298,6 +353,9 @@ module Nordlet
         end
       end
 
+      # Change a draft purchase order (409 once it is submitted); only the fields sent are changed. `lines` replace all
+      # existing lines and the totals are recomputed.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersUpdatePurchasesRequest]
       # @option request_options [String] :base_url
@@ -330,6 +388,8 @@ module Nordlet
         end
       end
 
+      # Return one purchase order with its lines; each line carries `receivedQty` and `remainingQty`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersGetPurchasesRequest]
       # @option request_options [String] :base_url
@@ -362,6 +422,10 @@ module Nordlet
         end
       end
 
+      # List purchase orders without lines, with the supplier's `partnerName`. Filterable by `partnerId`, `status`,
+      # `orderNumber`, `orderDate`, `currency` and `grossTotal`; sortable by `createdAt`, `orderDate`, `orderNumber` and
+      # `grossTotal`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersListPurchasesRequest]
       # @option request_options [String] :base_url
@@ -394,6 +458,9 @@ module Nordlet
         end
       end
 
+      # Move a `draft` purchase order to `submitted` for approval (409 from any other status). `reason` is kept in the
+      # audit log.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersSubmitPurchasesRequest]
       # @option request_options [String] :base_url
@@ -426,6 +493,10 @@ module Nordlet
         end
       end
 
+      # Approve a `submitted` purchase order (409 from any other status), recording who approved it and when; needs the
+      # `purchases:approve` scope. Goods are then received with `purchases/receipts/create`. Emits
+      # `purchase_order.approved`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersApprovePurchasesRequest]
       # @option request_options [String] :base_url
@@ -458,6 +529,9 @@ module Nordlet
         end
       end
 
+      # Send a `submitted` purchase order back to `draft` (409 from any other status); needs the `purchases:approve`
+      # scope. `reason` is kept in the audit log.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersRejectPurchasesRequest]
       # @option request_options [String] :base_url
@@ -490,6 +564,9 @@ module Nordlet
         end
       end
 
+      # Cancel a `draft`, `submitted` or `approved` purchase order (409 from any other status, or when the order already
+      # has a goods receipt).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersCancelPurchasesRequest]
       # @option request_options [String] :base_url
@@ -522,6 +599,9 @@ module Nordlet
         end
       end
 
+      # Close an `approved`, `partially_received` or `received` purchase order (409 from any other status); a closed
+      # order accepts no further goods receipts.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersClosePurchasesRequest]
       # @option request_options [String] :base_url
@@ -554,6 +634,8 @@ module Nordlet
         end
       end
 
+      # Mark a `draft` purchase order as deleted (409 once it is submitted).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::OrdersDeletePurchasesRequest]
       # @option request_options [String] :base_url
@@ -586,6 +668,14 @@ module Nordlet
         end
       end
 
+      # Record a goods receipt against an `approved` or `partially_received` purchase order (409 otherwise), numbered
+      # from the `goods_receipt` series with prefix GR. Lines whose item is a product go into stock in `warehouseId`,
+      # else the order's warehouse (422 when neither is set), at their share of the order line's net amount converted at
+      # the receipt date's rate; `lotNumber` and `expiryDate` receive them into a lot, and an item that needs lot or
+      # serial tracking is refused with 422 without one. A quantity above the line's remaining quantity is refused with
+      # 409; the order becomes `received` when every line is fully received, else `partially_received`. Emits
+      # `goods_receipt.posted`, `stock.changed` and, when fully received, `purchase_order.received`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::ReceiptsCreatePurchasesRequest]
       # @option request_options [String] :base_url
@@ -618,6 +708,8 @@ module Nordlet
         end
       end
 
+      # Return one goods receipt with its lines and their stock movement ids.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::ReceiptsGetPurchasesRequest]
       # @option request_options [String] :base_url
@@ -650,6 +742,9 @@ module Nordlet
         end
       end
 
+      # List goods receipts without lines. Filterable by `orderId`, `warehouseId`, `receiptDate` and `receiptNumber`;
+      # sortable by `createdAt` and `receiptDate`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::ReceiptsListPurchasesRequest]
       # @option request_options [String] :base_url
@@ -682,6 +777,13 @@ module Nordlet
         end
       end
 
+      # Compare a purchase invoice with its linked purchase order and the goods received so far, grouped by item (by
+      # description for lines without one). Each row is `matched`, `not_received` (invoiced but nothing received),
+      # `over_invoiced` (invoiced more than received), `price_mismatch` (unit price differs by more than
+      # `priceTolerancePercent`), `not_on_order` or `not_invoiced`; `status` is `mismatched` when any row other than
+      # `not_invoiced` is not matched. Refused with 422 when the invoice has no `purchaseOrderId` or its currency
+      # differs from the order's. Nothing is changed.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Purchases::Types::InvoicesMatchPurchasesRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/reference/client.rb

@@ -10,6 +10,10 @@ module Nordlet
         @client = client
       end
 
+      # Fetches the euro exchange rates the Bank of Lithuania web service publishes for `date` (default: the company's
+      # current date) and stores them in the rate table shared by all companies, replacing the rates already stored for
+      # that date. Answers 404 when no rates are published for the date.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::ExchangeRatesSyncReferenceRequest]
       # @option request_options [String] :base_url
@@ -42,6 +46,9 @@ module Nordlet
         end
       end
 
+      # Lists the stored euro exchange rates, which are shared by all companies. Filterable by `currencyCode` and
+      # `date`; sortable by `date` and `currencyCode`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::ExchangeRatesListReferenceRequest]
       # @option request_options [String] :base_url
@@ -74,6 +81,11 @@ module Nordlet
         end
       end
 
+      # Stores a company exchange rate for `currency` on `date`, in units of the currency per one unit of the company's
+      # base currency, replacing the company rate stored for that currency and date. Rate lookups use the company rate
+      # when it is dated on or after the latest shared rate on or before the lookup date. Answers 422 when `rate` is not
+      # positive.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::ExchangeRatesSetReferenceRequest]
       # @option request_options [String] :base_url
@@ -106,6 +118,9 @@ module Nordlet
         end
       end
 
+      # Lists the company's own exchange rates set with `reference/exchange-rates/set`. Filterable by `currencyCode` and
+      # `date`; sortable by `date` and `currencyCode`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::ExchangeRatesOverridesListReferenceRequest]
       # @option request_options [String] :base_url
@@ -138,6 +153,8 @@ module Nordlet
         end
       end
 
+      # Removes the company's own exchange rate for `currency` on `date`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::ExchangeRatesOverridesDeleteReferenceRequest]
       # @option request_options [String] :base_url
@@ -170,6 +187,8 @@ module Nordlet
         end
       end
 
+      # Lists every country code Nordlet knows with its EU and EEA membership and its name in each supported locale.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::CountriesListReferenceRequest]
       # @option request_options [String] :base_url
@@ -202,6 +221,8 @@ module Nordlet
         end
       end
 
+      # Lists the ten Lithuanian counties (apskritys) with their code and ISO code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::LtCountiesListReferenceRequest]
       # @option request_options [String] :base_url
@@ -234,6 +255,9 @@ module Nordlet
         end
       end
 
+      # Lists the Lithuanian municipalities (savivaldybės) with the county each belongs to; `countyCode` limits the list
+      # to one county.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::LtMunicipalitiesListReferenceRequest]
       # @option request_options [String] :base_url
@@ -266,6 +290,9 @@ module Nordlet
         end
       end
 
+      # Lists Lithuanian cities with their municipality; `municipalityCode` limits the list to one municipality and `q`
+      # to names that start with the given text (case-insensitive).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::LtCitiesListReferenceRequest]
       # @option request_options [String] :base_url
@@ -298,6 +325,9 @@ module Nordlet
         end
       end
 
+      # Lists the banks of the bank directory shared by all companies. Filterable by `countryCode`, `name`, `bic` and
+      # `bankCode`; sortable by `name`, `bic` and `countryCode`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::BanksListReferenceRequest]
       # @option request_options [String] :base_url
@@ -330,6 +360,9 @@ module Nordlet
         end
       end
 
+      # Adds a bank to the shared bank directory or, when a bank with the same `countryCode` and `bic` exists, replaces
+      # its name, bank code and active flag. Platform administrators only.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::BanksUpsertReferenceRequest]
       # @option request_options [String] :base_url
@@ -362,6 +395,9 @@ module Nordlet
         end
       end
 
+      # Lists the ten Lithuanian regions (apskritys) with their code and ISO code; the same list as
+      # `reference/lt/counties/list`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::LtRegionsListReferenceRequest]
       # @option request_options [String] :base_url
@@ -394,6 +430,8 @@ module Nordlet
         end
       end
 
+      # Lists the currencies known to Nordlet with their minor units. Filterable and sortable by `code` and `name`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::CurrenciesListReferenceRequest]
       # @option request_options [String] :base_url
@@ -426,6 +464,10 @@ module Nordlet
         end
       end
 
+      # Lists the company's VAT classifiers (code, country, name and rate). A document line that names a classifier in
+      # `vatClassifierCode` takes its rate from it when neither the line nor the item has a rate. Filterable by `code`,
+      # `countryCode` and `ratePercent`; sortable by `code` and `ratePercent`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::VatClassifiersListReferenceRequest]
       # @option request_options [String] :base_url
@@ -458,6 +500,9 @@ module Nordlet
         end
       end
 
+      # Adds VAT classifiers to the company or replaces the country, name and rate of the ones whose `code` already
+      # exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::VatClassifiersUpsertReferenceRequest]
       # @option request_options [String] :base_url
@@ -561,6 +606,14 @@ module Nordlet
         end
       end
 
+      # Works out the VAT treatment of a supply by this company: the scheme (domestic, intra-EU B2B, reverse charge,
+      # OSS, IOSS, marketplace deemed supplier, export, out of scope or SME exempt), the country whose VAT applies, its
+      # rates with the company's overrides applied, and the legal basis. The customer comes from `partnerId` (country
+      # from the partner's address or VAT number, business status from the VAT number) or from `customerCountryCode` and
+      # `customerIsBusiness`; `date` defaults to the company's current date; when `belowDistanceSalesThreshold` is not
+      # given, the distance-sales threshold is tracked from the company's ledger. Answers 422 when the partner has
+      # neither an address country nor a VAT code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::VatResolveReferenceRequest]
       # @option request_options [String] :base_url
@@ -593,6 +646,9 @@ module Nordlet
         end
       end
 
+      # Lists the Combined Nomenclature codes of the directory shared by all companies. Filterable by `code`, `name` and
+      # `nameLt`; sortable by `code`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::CnCodesListReferenceRequest]
       # @option request_options [String] :base_url
@@ -625,6 +681,9 @@ module Nordlet
         end
       end
 
+      # Adds Combined Nomenclature codes to the shared directory or replaces the names and supplementary unit of the
+      # codes that exist. Platform administrators only.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::CnCodesUpsertReferenceRequest]
       # @option request_options [String] :base_url
@@ -657,6 +716,9 @@ module Nordlet
         end
       end
 
+      # Lists the versions of the filing systems, schemas and forms Nordlet's output was checked against, with the date
+      # of the check and the source; `country` limits the list to one country.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::ComplianceVersionsListReferenceRequest]
       # @option request_options [String] :base_url
@@ -689,6 +751,9 @@ module Nordlet
         end
       end
 
+      # Lists the Intrastat thresholds stored per year: the reporting and the statistical-value threshold for arrivals
+      # and for dispatches.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::IntrastatThresholdsListReferenceRequest]
       # @option request_options [String] :base_url
@@ -721,6 +786,9 @@ module Nordlet
         end
       end
 
+      # Lists the measurement units of the directory shared by all companies, with Lithuanian and English names.
+      # Filterable by `code`, `nameLt` and `nameEn`; sortable by `code`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::UnitsListReferenceRequest]
       # @option request_options [String] :base_url
@@ -753,6 +821,9 @@ module Nordlet
         end
       end
 
+      # Creates a numbering series for a document type, prefix and year; the first number the series hands out is at
+      # least `startAt`. Answers 409 when a series with the same document type, prefix and year exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::SeriesCreateReferenceRequest]
       # @option request_options [String] :base_url
@@ -785,6 +856,9 @@ module Nordlet
         end
       end
 
+      # Lists the company's numbering series with the next number of each. Filterable and sortable by `documentType`,
+      # `prefix` and `year`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Reference::Types::SeriesListReferenceRequest]
       # @option request_options [String] :base_url