@bisondesk/core-sdk 1.0.681 → 1.0.682

package/lib/types/vehicle-purchase-payments.d.ts

@@ -55,6 +55,20 @@ export declare enum UnpaidPurchaseGroup {
     Arrived = "arrived",
     Expected = "expected"
 }
+export declare enum UnpaidPurchaseLogisticStatus {
+    Delivered = "delivered",
+    Arrived = "arrived",
+    Expected = "expected"
+}
+export type UnpaidPurchasesFilters = {
+    q?: string;
+    sold?: boolean;
+    logisticStatus?: UnpaidPurchaseLogisticStatus;
+    purchasedBy?: string[];
+    branchId?: string;
+    used?: boolean;
+    group?: UnpaidPurchaseGroup;
+};
 export type UnpaidPurchase = {
     group: UnpaidPurchaseGroup;
     vehicle: SearchVehicle;
@@ -67,6 +81,7 @@ export type UnpaidPurchase = {
 };
 export type UnpaidPurchasesMeta = {
     canAllowPayment: boolean;
+    purchasers: string[];
     counts: Record<UnpaidPurchaseGroup, number>;
 };
 export type ExportPaymentsRequest = {

package/lib/types/vehicle-purchase-payments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vehicle-purchase-payments.d.ts","sourceRoot":"/","sources":["types/vehicle-purchase-payments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,eAAO,MAAM,oDAAoD,kDAChB,CAAC;AASlD,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAMD,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IAErB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,EAAE,IAAI,CAAC,6BAA6B,EAAE,QAAQ,GAAG,cAAc,CAAC,CAAC;IACzE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,GAAG;IAChF,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,6BAA6B,CAAC;IACxC,KAAK,EAAE,YAAY,CAAC;IAEpB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,cAAc,CAAC,EAAE,MAAM,CAAC;IAOxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAOF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAcF,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;IACxB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,kBAAkB,EAAE,8BAA8B,EAAE,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,sBAAsB,CAAC;IAChC,OAAO,EAAE,aAAa,CAAC;IAEvB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AAOF,oBAAY,mBAAmB;IAC7B,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAMD,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,mBAAmB,CAAC;IAC3B,OAAO,EAAE,aAAa,CAAC;IAGvB,cAAc,EAAE,MAAM,CAAC;IAEvB,aAAa,EAAE,MAAM,CAAC;IAEtB,UAAU,EAAE,MAAM,CAAC;IAEnB,eAAe,EAAE,MAAM,CAAC;IAExB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAGF,MAAM,MAAM,mBAAmB,GAAG;IAEhC,eAAe,EAAE,OAAO,CAAC;IAEzB,MAAM,EAAE,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;CAC7C,CAAC;AAGF,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAGF,MAAM,MAAM,uBAAuB,GAAG;IACpC,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAMF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,EAAE,sBAAsB,CAAC;IAChC,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,MAAM,EAAE,QAAQ,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,EAAE,sBAAsB,CAAC;IAChC,eAAe,EAAE,sBAAsB,CAAC;IACxC,MAAM,EAAE,QAAQ,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,eAAe,EAAE,sBAAsB,CAAC;IACxC,MAAM,EAAE,QAAQ,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,SAAS,GACjD,CACI,iCAAiC,GACjC,iCAAiC,GACjC,iCAAiC,CACpC,CAAC"}
+{"version":3,"file":"vehicle-purchase-payments.d.ts","sourceRoot":"/","sources":["types/vehicle-purchase-payments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,eAAO,MAAM,oDAAoD,kDAChB,CAAC;AASlD,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAMD,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IAErB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,EAAE,IAAI,CAAC,6BAA6B,EAAE,QAAQ,GAAG,cAAc,CAAC,CAAC;IACzE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,GAAG;IAChF,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,6BAA6B,CAAC;IACxC,KAAK,EAAE,YAAY,CAAC;IAEpB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,cAAc,CAAC,EAAE,MAAM,CAAC;IAOxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAOF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAcF,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;IACxB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,kBAAkB,EAAE,8BAA8B,EAAE,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,sBAAsB,CAAC;IAChC,OAAO,EAAE,aAAa,CAAC;IAEvB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AAQF,oBAAY,mBAAmB;IAC7B,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAOD,oBAAY,4BAA4B;IACtC,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAGD,MAAM,MAAM,sBAAsB,GAAG;IAKnC,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,cAAc,CAAC,EAAE,4BAA4B,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B,CAAC;AAMF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,mBAAmB,CAAC;IAC3B,OAAO,EAAE,aAAa,CAAC;IAGvB,cAAc,EAAE,MAAM,CAAC;IAEvB,aAAa,EAAE,MAAM,CAAC;IAEtB,UAAU,EAAE,MAAM,CAAC;IAEnB,eAAe,EAAE,MAAM,CAAC;IAExB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAGF,MAAM,MAAM,mBAAmB,GAAG;IAEhC,eAAe,EAAE,OAAO,CAAC;IAEzB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB,MAAM,EAAE,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;CAC7C,CAAC;AAGF,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAGF,MAAM,MAAM,uBAAuB,GAAG;IACpC,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAMF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,EAAE,sBAAsB,CAAC;IAChC,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,MAAM,EAAE,QAAQ,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,EAAE,sBAAsB,CAAC;IAChC,eAAe,EAAE,sBAAsB,CAAC;IACxC,MAAM,EAAE,QAAQ,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,eAAe,EAAE,sBAAsB,CAAC;IACxC,MAAM,EAAE,QAAQ,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,SAAS,GACjD,CACI,iCAAiC,GACjC,iCAAiC,GACjC,iCAAiC,CACpC,CAAC"}

package/lib/types/vehicle-purchase-payments.js

@@ -11,4 +11,10 @@ export var UnpaidPurchaseGroup;
     UnpaidPurchaseGroup["Arrived"] = "arrived";
     UnpaidPurchaseGroup["Expected"] = "expected";
 })(UnpaidPurchaseGroup || (UnpaidPurchaseGroup = {}));
+export var UnpaidPurchaseLogisticStatus;
+(function (UnpaidPurchaseLogisticStatus) {
+    UnpaidPurchaseLogisticStatus["Delivered"] = "delivered";
+    UnpaidPurchaseLogisticStatus["Arrived"] = "arrived";
+    UnpaidPurchaseLogisticStatus["Expected"] = "expected";
+})(UnpaidPurchaseLogisticStatus || (UnpaidPurchaseLogisticStatus = {}));
 //# sourceMappingURL=vehicle-purchase-payments.js.map

package/lib/types/vehicle-purchase-payments.js.map

@@ -1 +1 @@
-{"version":3,"file":"vehicle-purchase-payments.js","sourceRoot":"/","sources":["types/vehicle-purchase-payments.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,oDAAoD,GAC/D,+CAA+C,CAAC;AASlD,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,yCAAyB,CAAA;IACzB,qCAAqB,CAAA;AACvB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AA6FD,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,0CAAmB,CAAA;IACnB,4CAAqB,CAAA;AACvB,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B","sourcesContent":["import { BaseEvent } from './internal-events.js';\nimport { OrganizationBankAccountActions } from './organization-bank-accounts.js';\nimport { SearchVehicle } from './vehicles.js';\n\nexport const VEHICLE_PURCHASE_PAYMENT_ALLOWED_NOTIFICATION_ORIGIN =\n  'vehicle-purchase-payment-allowed-notification';\n\n/**\n * The stage a supplier payment sits at, driving the Unpaid/Allowed/Processing/Executed tabs.\n * A payment only ever moves forward: an authorised payment is `allowed`; sending it to processing\n * groups it into a payment batch and hands it to accounting (`processing`), which exports it\n * to the Isabel bank file; marking it paid moves it to `executed`.\n * (`unpaid` is not a stage — it is an agreed purchase with an amount still to authorise.)\n */\nexport enum PaymentStage {\n  Allowed = 'allowed',\n  Processing = 'processing',\n  Executed = 'executed',\n}\n\n/**\n * A payment on a purchase priced in another currency is authorized and paid in that currency.\n * `amount` then holds its value in branch currency: `foreign.amount × foreign.exchangeRate`.\n */\nexport type VehiclePurchasePaymentForeign = {\n  amount: string;\n  currencyCode: string;\n  /** Branch currency units per 1 unit of `currencyCode`, the purchase's rate. */\n  exchangeRate: string;\n};\n\nexport type NewVehiclePurchasePayment = {\n  vehicleId: string;\n  /** Branch currency. Derived from `foreign` when the purchase is priced in another currency. */\n  amount: string;\n  /** The backend takes the rate from the purchase. */\n  foreign?: Pick<VehiclePurchasePaymentForeign, 'amount' | 'currencyCode'>;\n  description?: string;\n  paidAt?: string;\n  paidBy?: string;\n};\n\nexport type VehiclePurchasePayment = Omit<NewVehiclePurchasePayment, 'foreign'> & {\n  id: string;\n  createdBy: string;\n  createdAt: string;\n  foreign?: VehiclePurchasePaymentForeign;\n  stage: PaymentStage;\n  /** Manual settlement priority within the Allowed tab; lower is paid first. */\n  priority: number;\n  /** Set once the payment has been exported; links it to its payment export. */\n  exportId?: string;\n  /** The payment batch this payment was sent to processing in; unset while Allowed, and on payments\n   * marked paid straight from Allowed. */\n  paymentBatchId?: string;\n  /**\n   * Supplier-facing communication that becomes the SEPA transfer's remittance information (`RmtInf`),\n   * so the supplier can reconcile the payment to an invoice. Editable while Processing and not yet\n   * exported; prefilled from the latest purchase invoice. This is not the file's per-line\n   * `EndToEndId`.\n   */\n  transferReference?: string;\n  /** Who sent the payment to processing, and when — set at the Allowed → Processing step. */\n  sentToProcessingBy?: string;\n  sentToProcessingAt?: string;\n};\n\n/**\n * One send to processing: the Allowed payments an accountant moved to Processing together, and who\n * sent them. The Processing tab groups its rows by batch. A batch holds no amount of its own; its\n * total is the sum of the payments still in it.\n */\nexport type PaymentBatch = {\n  id: string;\n  createdAt: string;\n  createdBy: string;\n};\n\n/**\n * Whether a payment's supplier can be paid in an export. Mirrors the export gate: a transfer needs a\n * supplier bank account that carries an IBAN and holder name and has been verified. Shown as an\n * export-blocked marker on the Processing rows, where the accountant clears it before exporting.\n * (The invoice / pro-forma document half of the gate is not reflected here — its source is a Q3\n * residual the backend export gate also defers.)\n *\n * The bank account is the supplier's default one, `bankAccountId`, which is the account an export\n * pays. `bankAccountActions` lists what the current user may do on it, so a row can point out the\n * accounts they can verify themselves. Once the account number or holder name changed, verify is\n * left out for accountants, and for whichever Senior Accountant made the change (four-eyes).\n */\nexport type PaymentExportChecks = {\n  bankAccountId?: string;\n  hasBankAccount: boolean;\n  bankAccountVerified: boolean;\n  bankAccountActions: OrganizationBankAccountActions[];\n};\n\nexport type VehiclePurchasePaymentBff = {\n  payment: VehiclePurchasePayment;\n  vehicle: SearchVehicle;\n  /** Name of the supplier organisation (`vehicle.purchase.organizationId`), resolved for display. */\n  supplierName?: string;\n  /** Export checks on the supplier bank account; filled for the Processing list only. */\n  exportChecks?: PaymentExportChecks;\n};\n\n/**\n * The group an unpaid purchase is listed under, in the order the Unpaid list shows them: sold to a\n * client (whether or not it has arrived), arrived on our park and not sold, or still expected —\n * neither sold nor arrived.\n */\nexport enum UnpaidPurchaseGroup {\n  Sold = 'sold',\n  Arrived = 'arrived',\n  Expected = 'expected',\n}\n\n/**\n * A row on the Unpaid tab: an agreed purchase that still has an amount to authorise for payment.\n * Derived from the purchase deal and the payments already authorised, not a payment record.\n */\nexport type UnpaidPurchase = {\n  group: UnpaidPurchaseGroup;\n  vehicle: SearchVehicle;\n  /** The agreed purchase price including VAT (`deal.purchase` grossed up by `deal.purchaseVatRate`),\n   * so it matches the VAT-inclusive cost the vehicle purchase tab authorises against. */\n  purchaseAmount: string;\n  /** Sum of amounts already authorised (payments in any stage) for this vehicle. */\n  allowedAmount: string;\n  /** Sum of the authorised amounts already settled (payments in Executed) for this vehicle. */\n  paidAmount: string;\n  /** `purchaseAmount − allowedAmount`; always greater than zero for rows shown here. */\n  remainingAmount: string;\n  /** Due date of the purchase invoice. */\n  invoiceDueDate?: string;\n  /** Name of the supplier organisation (`vehicle.purchase.organizationId`), resolved for display. */\n  supplierName?: string;\n};\n\n/** What a page of one Unpaid group carries besides its rows. */\nexport type UnpaidPurchasesMeta = {\n  /** Whether the requester may authorise a payment, as on the vehicle purchase tab. */\n  canAllowPayment: boolean;\n  /** How many purchases each group holds, for the group headers. */\n  counts: Record<UnpaidPurchaseGroup, number>;\n};\n\n/** Body of the export request: the Processing payments to put in one file, the paying account, and the execution date. */\nexport type ExportPaymentsRequest = {\n  paymentIds: string[];\n  /** The bank account (from documents settings) to pay the file from — the file's debtor. */\n  debtorBankAccountId: string;\n  /** Single execution date (`yyyy-MM-dd`) written to `ReqdExctnDt`; defaults to today. */\n  executionDate?: string;\n};\n\n/** Body of the mark-paid request: the payments (Allowed or Processing) to settle in one call. */\nexport type MarkPaymentsPaidRequest = {\n  paymentIds: string[];\n};\n\n/** Body of the send-to-processing request: the Allowed payments to send together as one batch. */\nexport type SendPaymentsToProcessingRequest = {\n  paymentIds: string[];\n};\n\n/**\n * How many rows sit behind each payment tab, for the tab counters. Executed is unbounded and has no\n * counter, so it is left out.\n */\nexport type PurchasePaymentCounts = {\n  unpaid: number;\n  allowed: number;\n  processing: number;\n};\n\nexport type VehiclePurchasePaymentCreateEvent = {\n  payment: VehiclePurchasePayment;\n  previousPayment?: undefined;\n  action: 'create';\n  actionAt: string;\n  userId: string;\n  tenantId: string;\n};\n\nexport type VehiclePurchasePaymentUpdateEvent = {\n  payment: VehiclePurchasePayment;\n  previousPayment: VehiclePurchasePayment;\n  action: 'update';\n  actionAt: string;\n  userId: string;\n  tenantId: string;\n};\n\nexport type VehiclePurchasePaymentDeleteEvent = {\n  payment?: undefined;\n  previousPayment: VehiclePurchasePayment;\n  action: 'delete';\n  actionAt: string;\n  userId: string;\n  tenantId: string;\n};\n\nexport type VehiclePurchasePaymentEvent = BaseEvent &\n  (\n    | VehiclePurchasePaymentCreateEvent\n    | VehiclePurchasePaymentUpdateEvent\n    | VehiclePurchasePaymentDeleteEvent\n  );\n"]}
+{"version":3,"file":"vehicle-purchase-payments.js","sourceRoot":"/","sources":["types/vehicle-purchase-payments.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,oDAAoD,GAC/D,+CAA+C,CAAC;AASlD,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,yCAAyB,CAAA;IACzB,qCAAqB,CAAA;AACvB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AA8FD,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,0CAAmB,CAAA;IACnB,4CAAqB,CAAA;AACvB,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AAOD,MAAM,CAAN,IAAY,4BAIX;AAJD,WAAY,4BAA4B;IACtC,uDAAuB,CAAA;IACvB,mDAAmB,CAAA;IACnB,qDAAqB,CAAA;AACvB,CAAC,EAJW,4BAA4B,KAA5B,4BAA4B,QAIvC","sourcesContent":["import { BaseEvent } from './internal-events.js';\nimport { OrganizationBankAccountActions } from './organization-bank-accounts.js';\nimport { SearchVehicle } from './vehicles.js';\n\nexport const VEHICLE_PURCHASE_PAYMENT_ALLOWED_NOTIFICATION_ORIGIN =\n  'vehicle-purchase-payment-allowed-notification';\n\n/**\n * The stage a supplier payment sits at, driving the Unpaid/Allowed/Processing/Executed tabs.\n * A payment only ever moves forward: an authorised payment is `allowed`; sending it to processing\n * groups it into a payment batch and hands it to accounting (`processing`), which exports it\n * to the Isabel bank file; marking it paid moves it to `executed`.\n * (`unpaid` is not a stage — it is an agreed purchase with an amount still to authorise.)\n */\nexport enum PaymentStage {\n  Allowed = 'allowed',\n  Processing = 'processing',\n  Executed = 'executed',\n}\n\n/**\n * A payment on a purchase priced in another currency is authorized and paid in that currency.\n * `amount` then holds its value in branch currency: `foreign.amount × foreign.exchangeRate`.\n */\nexport type VehiclePurchasePaymentForeign = {\n  amount: string;\n  currencyCode: string;\n  /** Branch currency units per 1 unit of `currencyCode`, the purchase's rate. */\n  exchangeRate: string;\n};\n\nexport type NewVehiclePurchasePayment = {\n  vehicleId: string;\n  /** Branch currency. Derived from `foreign` when the purchase is priced in another currency. */\n  amount: string;\n  /** The backend takes the rate from the purchase. */\n  foreign?: Pick<VehiclePurchasePaymentForeign, 'amount' | 'currencyCode'>;\n  description?: string;\n  paidAt?: string;\n  paidBy?: string;\n};\n\nexport type VehiclePurchasePayment = Omit<NewVehiclePurchasePayment, 'foreign'> & {\n  id: string;\n  createdBy: string;\n  createdAt: string;\n  foreign?: VehiclePurchasePaymentForeign;\n  stage: PaymentStage;\n  /** Manual settlement priority within the Allowed tab; lower is paid first. */\n  priority: number;\n  /** Set once the payment has been exported; links it to its payment export. */\n  exportId?: string;\n  /** The payment batch this payment was sent to processing in; unset while Allowed, and on payments\n   * marked paid straight from Allowed. */\n  paymentBatchId?: string;\n  /**\n   * Supplier-facing communication that becomes the SEPA transfer's remittance information (`RmtInf`),\n   * so the supplier can reconcile the payment to an invoice. Editable while Processing and not yet\n   * exported; prefilled from the latest purchase invoice. This is not the file's per-line\n   * `EndToEndId`.\n   */\n  transferReference?: string;\n  /** Who sent the payment to processing, and when — set at the Allowed → Processing step. */\n  sentToProcessingBy?: string;\n  sentToProcessingAt?: string;\n};\n\n/**\n * One send to processing: the Allowed payments an accountant moved to Processing together, and who\n * sent them. The Processing tab groups its rows by batch. A batch holds no amount of its own; its\n * total is the sum of the payments still in it.\n */\nexport type PaymentBatch = {\n  id: string;\n  createdAt: string;\n  createdBy: string;\n};\n\n/**\n * Whether a payment's supplier can be paid in an export. Mirrors the export gate: a transfer needs a\n * supplier bank account that carries an IBAN and holder name and has been verified. Shown as an\n * export-blocked marker on the Processing rows, where the accountant clears it before exporting.\n * (The invoice / pro-forma document half of the gate is not reflected here — its source is a Q3\n * residual the backend export gate also defers.)\n *\n * The bank account is the supplier's default one, `bankAccountId`, which is the account an export\n * pays. `bankAccountActions` lists what the current user may do on it, so a row can point out the\n * accounts they can verify themselves. Once the account number or holder name changed, verify is\n * left out for accountants, and for whichever Senior Accountant made the change (four-eyes).\n */\nexport type PaymentExportChecks = {\n  bankAccountId?: string;\n  hasBankAccount: boolean;\n  bankAccountVerified: boolean;\n  bankAccountActions: OrganizationBankAccountActions[];\n};\n\nexport type VehiclePurchasePaymentBff = {\n  payment: VehiclePurchasePayment;\n  vehicle: SearchVehicle;\n  /** Name of the supplier organisation (`vehicle.purchase.organizationId`), resolved for display. */\n  supplierName?: string;\n  /** Export checks on the supplier bank account; filled for the Processing list only. */\n  exportChecks?: PaymentExportChecks;\n};\n\n/**\n * The group an unpaid purchase falls in, in the order the Unpaid list ranks them: sold to a client\n * (whether or not it has arrived), arrived on our park and not sold, or still expected — neither\n * sold nor arrived. The single Unpaid list filters by `sold` and `logisticStatus` instead; the\n * `group` filter and `meta.counts` serve the client that paged each group on its own.\n */\nexport enum UnpaidPurchaseGroup {\n  Sold = 'sold',\n  Arrived = 'arrived',\n  Expected = 'expected',\n}\n\n/**\n * Where the vehicle behind an unpaid purchase stands, in the order the Unpaid list ranks its sales:\n * delivered to the client, arrived on our park, or still expected from the supplier. Delivered comes\n * from the sale side, so only a sold vehicle is delivered, whether or not it passed our park.\n */\nexport enum UnpaidPurchaseLogisticStatus {\n  Delivered = 'delivered',\n  Arrived = 'arrived',\n  Expected = 'expected',\n}\n\n/** The filters on the Unpaid list. A filter left out keeps every purchase. */\nexport type UnpaidPurchasesFilters = {\n  /**\n   * Free text, case-insensitive: every word must appear in the stock number, VIN, vehicle title or\n   * supplier name.\n   */\n  q?: string;\n  sold?: boolean;\n  logisticStatus?: UnpaidPurchaseLogisticStatus;\n  /** Purchasers (`purchase.purchasedBy`); a purchase matches any of them. */\n  purchasedBy?: string[];\n  branchId?: string;\n  /** The vehicle's condition (`external.condition.used`); a vehicle without one matches neither. */\n  used?: boolean;\n  group?: UnpaidPurchaseGroup;\n};\n\n/**\n * A row on the Unpaid tab: an agreed purchase that still has an amount to authorise for payment.\n * Derived from the purchase deal and the payments already authorised, not a payment record.\n */\nexport type UnpaidPurchase = {\n  group: UnpaidPurchaseGroup;\n  vehicle: SearchVehicle;\n  /** The agreed purchase price including VAT (`deal.purchase` grossed up by `deal.purchaseVatRate`),\n   * so it matches the VAT-inclusive cost the vehicle purchase tab authorises against. */\n  purchaseAmount: string;\n  /** Sum of amounts already authorised (payments in any stage) for this vehicle. */\n  allowedAmount: string;\n  /** Sum of the authorised amounts already settled (payments in Executed) for this vehicle. */\n  paidAmount: string;\n  /** `purchaseAmount − allowedAmount`; always greater than zero for rows shown here. */\n  remainingAmount: string;\n  /** Due date of the purchase invoice. */\n  invoiceDueDate?: string;\n  /** Name of the supplier organisation (`vehicle.purchase.organizationId`), resolved for display. */\n  supplierName?: string;\n};\n\n/** What a page of the Unpaid list carries besides its rows. */\nexport type UnpaidPurchasesMeta = {\n  /** Whether the requester may authorise a payment, as on the vehicle purchase tab. */\n  canAllowPayment: boolean;\n  /** Everyone who purchased an unpaid purchase, unfiltered, for the purchaser filter. */\n  purchasers: string[];\n  /** How many purchases each group holds, unfiltered. */\n  counts: Record<UnpaidPurchaseGroup, number>;\n};\n\n/** Body of the export request: the Processing payments to put in one file, the paying account, and the execution date. */\nexport type ExportPaymentsRequest = {\n  paymentIds: string[];\n  /** The bank account (from documents settings) to pay the file from — the file's debtor. */\n  debtorBankAccountId: string;\n  /** Single execution date (`yyyy-MM-dd`) written to `ReqdExctnDt`; defaults to today. */\n  executionDate?: string;\n};\n\n/** Body of the mark-paid request: the payments (Allowed or Processing) to settle in one call. */\nexport type MarkPaymentsPaidRequest = {\n  paymentIds: string[];\n};\n\n/** Body of the send-to-processing request: the Allowed payments to send together as one batch. */\nexport type SendPaymentsToProcessingRequest = {\n  paymentIds: string[];\n};\n\n/**\n * How many rows sit behind each payment tab, for the tab counters. Executed is unbounded and has no\n * counter, so it is left out.\n */\nexport type PurchasePaymentCounts = {\n  unpaid: number;\n  allowed: number;\n  processing: number;\n};\n\nexport type VehiclePurchasePaymentCreateEvent = {\n  payment: VehiclePurchasePayment;\n  previousPayment?: undefined;\n  action: 'create';\n  actionAt: string;\n  userId: string;\n  tenantId: string;\n};\n\nexport type VehiclePurchasePaymentUpdateEvent = {\n  payment: VehiclePurchasePayment;\n  previousPayment: VehiclePurchasePayment;\n  action: 'update';\n  actionAt: string;\n  userId: string;\n  tenantId: string;\n};\n\nexport type VehiclePurchasePaymentDeleteEvent = {\n  payment?: undefined;\n  previousPayment: VehiclePurchasePayment;\n  action: 'delete';\n  actionAt: string;\n  userId: string;\n  tenantId: string;\n};\n\nexport type VehiclePurchasePaymentEvent = BaseEvent &\n  (\n    | VehiclePurchasePaymentCreateEvent\n    | VehiclePurchasePaymentUpdateEvent\n    | VehiclePurchasePaymentDeleteEvent\n  );\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/core-sdk",
-  "version": "1.0.681",
+  "version": "1.0.682",
   "description": "",
   "type": "module",
   "author": "TheTruckCompany",

package/src/types/vehicle-purchase-payments.ts

@@ -105,9 +105,10 @@ export type VehiclePurchasePaymentBff = {
 };
 
 /**
- * The group an unpaid purchase is listed under, in the order the Unpaid list shows them: sold to a
- * client (whether or not it has arrived), arrived on our park and not sold, or still expected —
- * neither sold nor arrived.
+ * The group an unpaid purchase falls in, in the order the Unpaid list ranks them: sold to a client
+ * (whether or not it has arrived), arrived on our park and not sold, or still expected — neither
+ * sold nor arrived. The single Unpaid list filters by `sold` and `logisticStatus` instead; the
+ * `group` filter and `meta.counts` serve the client that paged each group on its own.
  */
 export enum UnpaidPurchaseGroup {
   Sold = 'sold',
@@ -115,6 +116,34 @@ export enum UnpaidPurchaseGroup {
   Expected = 'expected',
 }
 
+/**
+ * Where the vehicle behind an unpaid purchase stands, in the order the Unpaid list ranks its sales:
+ * delivered to the client, arrived on our park, or still expected from the supplier. Delivered comes
+ * from the sale side, so only a sold vehicle is delivered, whether or not it passed our park.
+ */
+export enum UnpaidPurchaseLogisticStatus {
+  Delivered = 'delivered',
+  Arrived = 'arrived',
+  Expected = 'expected',
+}
+
+/** The filters on the Unpaid list. A filter left out keeps every purchase. */
+export type UnpaidPurchasesFilters = {
+  /**
+   * Free text, case-insensitive: every word must appear in the stock number, VIN, vehicle title or
+   * supplier name.
+   */
+  q?: string;
+  sold?: boolean;
+  logisticStatus?: UnpaidPurchaseLogisticStatus;
+  /** Purchasers (`purchase.purchasedBy`); a purchase matches any of them. */
+  purchasedBy?: string[];
+  branchId?: string;
+  /** The vehicle's condition (`external.condition.used`); a vehicle without one matches neither. */
+  used?: boolean;
+  group?: UnpaidPurchaseGroup;
+};
+
 /**
  * A row on the Unpaid tab: an agreed purchase that still has an amount to authorise for payment.
  * Derived from the purchase deal and the payments already authorised, not a payment record.
@@ -137,11 +166,13 @@ export type UnpaidPurchase = {
   supplierName?: string;
 };
 
-/** What a page of one Unpaid group carries besides its rows. */
+/** What a page of the Unpaid list carries besides its rows. */
 export type UnpaidPurchasesMeta = {
   /** Whether the requester may authorise a payment, as on the vehicle purchase tab. */
   canAllowPayment: boolean;
-  /** How many purchases each group holds, for the group headers. */
+  /** Everyone who purchased an unpaid purchase, unfiltered, for the purchaser filter. */
+  purchasers: string[];
+  /** How many purchases each group holds, unfiltered. */
   counts: Record<UnpaidPurchaseGroup, number>;
 };