update_invoice

Instructions

Implementation Reference

• src/tools/invoices/updateInvoice.ts:121-144 (handler)

  The handler function that parses args, transforms amounts to cents, maps shipping address, and calls the service layer's updateInvoice.

  async function handler(client: Client, args: Record<string, unknown> | undefined) {
    const parsed = schema.safeParse(args);
    if (!parsed.success) {
      return errorResult(parsed.error.errors.map((e) => e.message).join("; "));
    }
    const { invoiceId, shippingAddress: rawShipping, ...rest } = parsed.data;
    let shippingAddress: invoiceService.InvoiceAddressInput | undefined;
    if (rawShipping) {
      shippingAddress = await mapShippingAddressInputToApiShippingAddress(client, rawShipping);
    }
    const detail = rest.detail
      ? rest.detail.map((item) => ({
          ...item,
          amount: normalizeAmountToCents(item.amount),
        }))
      : undefined;
  
    const body: invoiceService.UpdateInvoiceBody = {
      ...rest,
      detail,
      shippingAddress,
    };
    return handleToolCall(() => invoiceService.updateInvoice(client, invoiceId, body));
  }

• src/tools/invoices/updateInvoice.ts:63-81 (schema)

  Zod validation schema for the update_invoice tool's input parameters.

  const schema = z.object({
    invoiceId: z.string().min(1, "invoiceId is required"),
    companyGatewayId: z.number().int().positive().optional(),
    customerId: z.number().int().positive().optional(),
    customerEmail: z.string().max(45).optional(),
    customerName: z.string().max(45).optional(),
    customerPhone: z.string().max(45).optional(),
    customerPaymentMethodId: z.number().int().optional(),
    dateDue: z.string().optional(),
    dateFrom: z.string().optional(),
    dateTo: z.string().optional(),
    comments: z.string().optional(),
    paymentType: z.enum(paymentTypeEnum).optional(),
    paymentMethodId: z.number().int().optional(),
    shippingAddress: addressSchema.optional(),
    shippingAmount: z.number().int().min(0).optional(),
    shippingServiceId: z.string().optional(),
    detail: z.array(detailItemSchema).optional(),
  });

• src/services/invoiceServices.ts:68-86 (schema)

  TypeScript interface for the update invoice request body passed to the service layer.

  export interface UpdateInvoiceBody {
    companyGatewayId?: number;
    customerId?: number;
    customerEmail?: string;
    customerName?: string;
    customerPhone?: string;
    customerPaymentMethodId?: number;
    dateDue?: string;
    dateFrom?: string;
    dateTo?: string;
    comments?: string;
    paymentType?: "offlinePaymentProvider" | "thirdPartyPaymentProvider" | "walletPaymentProvider";
    paymentMethodId?: number;
    shippingAddress?: InvoiceAddressInput;
    shippingAmount?: number;
    shippingServiceId?: string;
    detail?: InvoiceDetailItemInput[];
    [k: string]: unknown;
  }

• src/tools/invoices/index.ts:16-27 (registration)

  Registration of updateInvoiceTool alongside all other invoice tools.

  export function registerInvoiceTools(): Tool[] {
    return [
      listInvoicesTool,
      getInvoiceTool,
      createInvoiceTool,
      updateInvoiceTool,
      deleteInvoiceTool,
      chargeInvoiceTool,
      chargeInvoiceExternalTool,
      voidInvoiceTool,
    ];
  }

• src/services/invoiceServices.ts:130-140 (helper)

  Service-layer helper that performs the PUT /invoices/{invoiceId} HTTP call.

  export async function updateInvoice(
    client: Client,
    invoiceId: string,
    body: UpdateInvoiceBody
  ): Promise<unknown> {
    const payload = Object.fromEntries(
      Object.entries(body).filter(([, v]) => v !== undefined)
    ) as UpdateInvoiceBody;
    // Always send a JSON body; some server paths expect it and may throw getId() on null when body is missing
    return client.put<unknown>(`/invoices/${invoiceId}`, Object.keys(payload).length ? payload : {});
  }