@vulog/aima-billing 1.2.36 → 1.2.37

package/dist/index.d.cts

@@ -122,6 +122,84 @@ type RefundableAmount = {
   refundablePaymentReceipts: Receipt[];
   refundedPaymentReceipts: Receipt[];
 };
+/** Billing line item returned by the trip invoices endpoint (nested in Billing array). */
+type TripBillingItem = {
+  trip?: unknown;
+  product?: unknown;
+  vehiculeModelName?: string;
+  vehiculePlate?: string;
+  modelId?: string;
+  userId?: string;
+  withoutTaxAmountForDriving?: number;
+  withoutTaxAmountForStopover?: number;
+  withoutTaxAmountForBooking?: number;
+  withoutTaxForOvermileage?: number;
+  withoutTaxAmountForStartZoneFee?: number;
+  withoutTaxAmountForEndZoneFee?: number;
+  withoutTaxAmountForCancellationFee?: number;
+  withoutTaxAmountForScheduleTripFee?: number;
+  withoutTaxAmountForTripSystemCredit?: number;
+  withoutTaxAmountForBillingGroupDiscount?: number | null;
+  withTaxAmountForDriving?: number;
+  withTaxAmountForStopover?: number;
+  withTaxAmountForBooking?: number;
+  withTaxForOvermileage?: number;
+  withTaxAmountForStartZoneFee?: number;
+  withTaxAmountForEndZoneFee?: number;
+  withTaxAmountForCancellationFee?: number;
+  withTaxAmountForScheduleTripFee?: number;
+  withTaxAmountForTripSystemCredit?: number;
+  withTaxAmountForBillingGroupDiscount?: number;
+  withoutTaxInitialTotalAmount?: number;
+  withTaxInitialTotalAmount?: number;
+  taxInitialTotalAmount?: number;
+  paymentMethodType?: string;
+  walletId?: string | null;
+  totalTaxAmount?: number;
+  totalWithTax?: number;
+  totalWithoutTax?: number;
+  taxRate?: number;
+  taxName?: string;
+  withoutTaxAmountRideCost?: number;
+  withTaxAmountRideCost?: number;
+  taxAmountRideCost?: number;
+  products?: unknown[];
+  taxesPerRate?: unknown;
+  serviceId?: string | null;
+  profileId?: string | null;
+  profileType?: string | null;
+  profileName?: string | null;
+  withoutTaxUnlockFee?: number;
+  withTaxUnlockFee?: number;
+  taxUnlockFee?: number;
+  withTaxRefundAmount?: number | null;
+  isRefunded?: boolean;
+  cityName?: string | null;
+  cityId?: string | null;
+  tripBillingBreakdown?: unknown;
+  pricingId?: string;
+  netJourney?: number;
+  taxJourney?: number;
+  grossJourney?: number;
+  durationJourney?: number;
+  taxRemainingToBePaid?: number;
+  grossRemainingToBePaid?: number;
+  netRemainingToBePaid?: number;
+  overriddenTripInfo?: unknown;
+  interrupted?: boolean;
+  interruptedReason?: string | null;
+  invoice?: unknown;
+  distanceUnit?: string;
+  isTaxIncluded?: boolean;
+  [key: string]: unknown;
+};
+/** Response shape of GET .../trips/:tripId/invoices */
+type InvoicesByTripIdResponse = {
+  balance: number;
+  userId: string;
+  entityId: string;
+  Billing: TripBillingItem[];
+};
 type Wallet = {
   initialAmount: number;
   validityStartDate: string;
@@ -157,7 +235,7 @@ declare const getInvoiceById: (client: Client, id: string) => Promise<Invoice>;
 declare const getInvoicePdf: (client: Client, invoiceId: string) => Promise<ArrayBuffer | null>;
 //#endregion
 //#region src/getInvoicesByTripId.d.ts
-declare const getInvoicesByTripId: (client: Client, tripId: string) => Promise<Invoice[]>;
+declare const getInvoicesByTripId: (client: Client, tripId: string) => Promise<InvoicesByTripIdResponse>;
 //#endregion
 //#region src/getRefundableAmount.d.ts
 declare const getRefundableAmount: (client: Client, invoiceId: string) => Promise<RefundableAmount>;
@@ -182,4 +260,4 @@ declare const updateWallet: (client: Client, walletId: string, actions: PatchAct
 //#region src/payInvoice.d.ts
 declare const payInvoice: (client: Client, invoiceId: string, manualPayment: ManualPayment) => Promise<Invoice>;
 //#endregion
-export { ChargeProductInfo, Credit, Invoice, ManualPayment, Paths, Receipt, RefundableAmount, Wallet, addCredits, chargeProduct, getInvoiceById, getInvoicePdf, getInvoicesByTripId, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };
+export { ChargeProductInfo, Credit, Invoice, InvoicesByTripIdResponse, ManualPayment, Paths, Receipt, RefundableAmount, TripBillingItem, Wallet, addCredits, chargeProduct, getInvoiceById, getInvoicePdf, getInvoicesByTripId, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };

package/dist/index.d.mts

@@ -122,6 +122,84 @@ type RefundableAmount = {
   refundablePaymentReceipts: Receipt[];
   refundedPaymentReceipts: Receipt[];
 };
+/** Billing line item returned by the trip invoices endpoint (nested in Billing array). */
+type TripBillingItem = {
+  trip?: unknown;
+  product?: unknown;
+  vehiculeModelName?: string;
+  vehiculePlate?: string;
+  modelId?: string;
+  userId?: string;
+  withoutTaxAmountForDriving?: number;
+  withoutTaxAmountForStopover?: number;
+  withoutTaxAmountForBooking?: number;
+  withoutTaxForOvermileage?: number;
+  withoutTaxAmountForStartZoneFee?: number;
+  withoutTaxAmountForEndZoneFee?: number;
+  withoutTaxAmountForCancellationFee?: number;
+  withoutTaxAmountForScheduleTripFee?: number;
+  withoutTaxAmountForTripSystemCredit?: number;
+  withoutTaxAmountForBillingGroupDiscount?: number | null;
+  withTaxAmountForDriving?: number;
+  withTaxAmountForStopover?: number;
+  withTaxAmountForBooking?: number;
+  withTaxForOvermileage?: number;
+  withTaxAmountForStartZoneFee?: number;
+  withTaxAmountForEndZoneFee?: number;
+  withTaxAmountForCancellationFee?: number;
+  withTaxAmountForScheduleTripFee?: number;
+  withTaxAmountForTripSystemCredit?: number;
+  withTaxAmountForBillingGroupDiscount?: number;
+  withoutTaxInitialTotalAmount?: number;
+  withTaxInitialTotalAmount?: number;
+  taxInitialTotalAmount?: number;
+  paymentMethodType?: string;
+  walletId?: string | null;
+  totalTaxAmount?: number;
+  totalWithTax?: number;
+  totalWithoutTax?: number;
+  taxRate?: number;
+  taxName?: string;
+  withoutTaxAmountRideCost?: number;
+  withTaxAmountRideCost?: number;
+  taxAmountRideCost?: number;
+  products?: unknown[];
+  taxesPerRate?: unknown;
+  serviceId?: string | null;
+  profileId?: string | null;
+  profileType?: string | null;
+  profileName?: string | null;
+  withoutTaxUnlockFee?: number;
+  withTaxUnlockFee?: number;
+  taxUnlockFee?: number;
+  withTaxRefundAmount?: number | null;
+  isRefunded?: boolean;
+  cityName?: string | null;
+  cityId?: string | null;
+  tripBillingBreakdown?: unknown;
+  pricingId?: string;
+  netJourney?: number;
+  taxJourney?: number;
+  grossJourney?: number;
+  durationJourney?: number;
+  taxRemainingToBePaid?: number;
+  grossRemainingToBePaid?: number;
+  netRemainingToBePaid?: number;
+  overriddenTripInfo?: unknown;
+  interrupted?: boolean;
+  interruptedReason?: string | null;
+  invoice?: unknown;
+  distanceUnit?: string;
+  isTaxIncluded?: boolean;
+  [key: string]: unknown;
+};
+/** Response shape of GET .../trips/:tripId/invoices */
+type InvoicesByTripIdResponse = {
+  balance: number;
+  userId: string;
+  entityId: string;
+  Billing: TripBillingItem[];
+};
 type Wallet = {
   initialAmount: number;
   validityStartDate: string;
@@ -157,7 +235,7 @@ declare const getInvoiceById: (client: Client, id: string) => Promise<Invoice>;
 declare const getInvoicePdf: (client: Client, invoiceId: string) => Promise<ArrayBuffer | null>;
 //#endregion
 //#region src/getInvoicesByTripId.d.ts
-declare const getInvoicesByTripId: (client: Client, tripId: string) => Promise<Invoice[]>;
+declare const getInvoicesByTripId: (client: Client, tripId: string) => Promise<InvoicesByTripIdResponse>;
 //#endregion
 //#region src/getRefundableAmount.d.ts
 declare const getRefundableAmount: (client: Client, invoiceId: string) => Promise<RefundableAmount>;
@@ -182,4 +260,4 @@ declare const updateWallet: (client: Client, walletId: string, actions: PatchAct
 //#region src/payInvoice.d.ts
 declare const payInvoice: (client: Client, invoiceId: string, manualPayment: ManualPayment) => Promise<Invoice>;
 //#endregion
-export { ChargeProductInfo, Credit, Invoice, ManualPayment, Paths, Receipt, RefundableAmount, Wallet, addCredits, chargeProduct, getInvoiceById, getInvoicePdf, getInvoicesByTripId, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };
+export { ChargeProductInfo, Credit, Invoice, InvoicesByTripIdResponse, ManualPayment, Paths, Receipt, RefundableAmount, TripBillingItem, Wallet, addCredits, chargeProduct, getInvoiceById, getInvoicePdf, getInvoicesByTripId, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@vulog/aima-billing",
     "type": "module",
-    "version": "1.2.36",
+    "version": "1.2.37",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",
     "types": "dist/index.d.cts",
@@ -32,8 +32,8 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.2.36",
-        "@vulog/aima-core": "1.2.36"
+        "@vulog/aima-client": "1.2.37",
+        "@vulog/aima-core": "1.2.37"
     },
     "peerDependencies": {
         "zod": "^3.25.76"

package/src/getInvoicesByTripId.test.ts

@@ -1,7 +1,7 @@
 import { describe, test, expect, vi, beforeEach } from 'vitest';
 import { Client } from '@vulog/aima-client';
 import { getInvoicesByTripId } from './getInvoicesByTripId';
-import type { Invoice } from './types';
+import type { InvoicesByTripIdResponse } from './types';
 
 describe('getInvoicesByTripId', () => {
     const getMock = vi.fn();
@@ -29,27 +29,27 @@ describe('getInvoicesByTripId', () => {
         expect(getMock).not.toHaveBeenCalled();
     });
 
-    test('calls GET with correct URL and returns invoices', async () => {
+    test('calls GET with correct URL and returns trip billing response', async () => {
         const tripId = 'BEBD00056A9A16103D418CC36D940E26';
-        const invoices: Invoice[] = [
-            {
-                id: '66bcbd77-37ef-47bd-b9af-877e5d213b8f',
-                sequence: 1,
-                userId: '20fb98a3-b60d-491a-9359-62e55f51fcb9',
-                invoiceDate: '2026-03-03',
-                updateDate: '2026-03-03T09:46:50Z',
-                fleetId: 'FLEET_ID',
-                invoiceYear: 2026,
-                invoicesStatus: 'PAID',
-                amount: 100,
-                currency: 'EUR',
-                entityId: 'entity-1',
-                attempts: 0,
-                pspReference: 'ref-1',
-                withTaxRefundAmount: 0,
-            },
-        ];
-        getMock.mockResolvedValueOnce({ data: invoices });
+        const response: InvoicesByTripIdResponse = {
+            balance: 499.99,
+            userId: '20fb98a3-b60d-491a-9359-62e55f51fcb9',
+            entityId: 'ba0b4e0b-ff0a-49f5-8e98-065b54355df9',
+            Billing: [
+                {
+                    vehiculeModelName: 'Yaris_Subs',
+                    vehiculePlate: 'Yaris_Abo_001',
+                    modelId: '1754',
+                    userId: '20fb98a3-b60d-491a-9359-62e55f51fcb9',
+                    withTaxInitialTotalAmount: 499.99,
+                    totalWithTax: 499.99,
+                    pricingId: '96e1fff7-d422-4181-8e19-1b2759b2f073',
+                    distanceUnit: 'KM',
+                    isTaxIncluded: true,
+                },
+            ],
+        };
+        getMock.mockResolvedValueOnce({ data: response });
 
         const result = await getInvoicesByTripId(client, tripId);
 
@@ -57,17 +57,25 @@ describe('getInvoicesByTripId', () => {
         expect(getMock).toHaveBeenCalledWith(
             `/boapi/proxy/billing/fleets/FLEET_ID/trips/${tripId}/invoices`
         );
-        expect(result).toEqual(invoices);
-        expect(result).toHaveLength(1);
-        expect(result[0].id).toBe(invoices[0].id);
+        expect(result).toEqual(response);
+        expect(result.balance).toBe(499.99);
+        expect(result.Billing).toHaveLength(1);
+        expect(result.Billing[0].vehiculeModelName).toBe('Yaris_Subs');
     });
 
-    test('returns empty array when no invoices', async () => {
+    test('returns response with empty Billing array when no billing items', async () => {
         const tripId = 'some-trip-id';
-        getMock.mockResolvedValueOnce({ data: [] });
+        const response: InvoicesByTripIdResponse = {
+            balance: 0,
+            userId: 'user-id',
+            entityId: 'entity-id',
+            Billing: [],
+        };
+        getMock.mockResolvedValueOnce({ data: response });
 
         const result = await getInvoicesByTripId(client, tripId);
 
-        expect(result).toEqual([]);
+        expect(result).toEqual(response);
+        expect(result.Billing).toEqual([]);
     });
 });

package/src/getInvoicesByTripId.ts

@@ -1,9 +1,9 @@
 import { Client } from '@vulog/aima-client';
 import { z } from 'zod';
 
-import { Invoice } from './types';
+import { InvoicesByTripIdResponse } from './types';
 
-export const getInvoicesByTripId = async (client: Client, tripId: string): Promise<Invoice[]> => {
+export const getInvoicesByTripId = async (client: Client, tripId: string): Promise<InvoicesByTripIdResponse> => {
     const result = z.string().trim().min(1).safeParse(tripId);
     if (!result.success) {
         throw new TypeError('Invalid args', {
@@ -12,6 +12,8 @@ export const getInvoicesByTripId = async (client: Client, tripId: string): Promi
     }
 
     return client
-        .get<Invoice[]>(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/trips/${result.data}/invoices`)
+        .get<InvoicesByTripIdResponse>(
+            `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/trips/${result.data}/invoices`
+        )
         .then(({ data }) => data);
 };

package/src/types.ts

@@ -135,6 +135,86 @@ export type RefundableAmount = {
     refundedPaymentReceipts: Receipt[];
 };
 
+/** Billing line item returned by the trip invoices endpoint (nested in Billing array). */
+export type TripBillingItem = {
+    trip?: unknown;
+    product?: unknown;
+    vehiculeModelName?: string;
+    vehiculePlate?: string;
+    modelId?: string;
+    userId?: string;
+    withoutTaxAmountForDriving?: number;
+    withoutTaxAmountForStopover?: number;
+    withoutTaxAmountForBooking?: number;
+    withoutTaxForOvermileage?: number;
+    withoutTaxAmountForStartZoneFee?: number;
+    withoutTaxAmountForEndZoneFee?: number;
+    withoutTaxAmountForCancellationFee?: number;
+    withoutTaxAmountForScheduleTripFee?: number;
+    withoutTaxAmountForTripSystemCredit?: number;
+    withoutTaxAmountForBillingGroupDiscount?: number | null;
+    withTaxAmountForDriving?: number;
+    withTaxAmountForStopover?: number;
+    withTaxAmountForBooking?: number;
+    withTaxForOvermileage?: number;
+    withTaxAmountForStartZoneFee?: number;
+    withTaxAmountForEndZoneFee?: number;
+    withTaxAmountForCancellationFee?: number;
+    withTaxAmountForScheduleTripFee?: number;
+    withTaxAmountForTripSystemCredit?: number;
+    withTaxAmountForBillingGroupDiscount?: number;
+    withoutTaxInitialTotalAmount?: number;
+    withTaxInitialTotalAmount?: number;
+    taxInitialTotalAmount?: number;
+    paymentMethodType?: string;
+    walletId?: string | null;
+    totalTaxAmount?: number;
+    totalWithTax?: number;
+    totalWithoutTax?: number;
+    taxRate?: number;
+    taxName?: string;
+    withoutTaxAmountRideCost?: number;
+    withTaxAmountRideCost?: number;
+    taxAmountRideCost?: number;
+    products?: unknown[];
+    taxesPerRate?: unknown;
+    serviceId?: string | null;
+    profileId?: string | null;
+    profileType?: string | null;
+    profileName?: string | null;
+    withoutTaxUnlockFee?: number;
+    withTaxUnlockFee?: number;
+    taxUnlockFee?: number;
+    withTaxRefundAmount?: number | null;
+    isRefunded?: boolean;
+    cityName?: string | null;
+    cityId?: string | null;
+    tripBillingBreakdown?: unknown;
+    pricingId?: string;
+    netJourney?: number;
+    taxJourney?: number;
+    grossJourney?: number;
+    durationJourney?: number;
+    taxRemainingToBePaid?: number;
+    grossRemainingToBePaid?: number;
+    netRemainingToBePaid?: number;
+    overriddenTripInfo?: unknown;
+    interrupted?: boolean;
+    interruptedReason?: string | null;
+    invoice?: unknown;
+    distanceUnit?: string;
+    isTaxIncluded?: boolean;
+    [key: string]: unknown;
+};
+
+/** Response shape of GET .../trips/:tripId/invoices */
+export type InvoicesByTripIdResponse = {
+    balance: number;
+    userId: string;
+    entityId: string;
+    Billing: TripBillingItem[];
+};
+
 export type Wallet = {
     initialAmount: number;
     validityStartDate: string;