update_invoice
Modify existing invoice details in Visa Acceptance, including customer information, payment terms, and order amounts, to maintain accurate billing records.
Instructions
This tool will update an invoice in Visa Acceptance.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Invoice ID (required) | |
| customerInformation | Yes | Customer information object (required even if properties are optional) | |
| invoiceInformation | Yes | Invoice information object (required even if properties are optional) | |
| orderInformation | Yes | Order information object (required) |
Implementation Reference
- The handler function that executes the update_invoice tool logic by calling the Cybersource InvoicesApi to update the invoice.export const updateInvoice = async ( visaClient: any, context: VisaContext, params: z.infer<ReturnType<typeof updateInvoiceParameters>> ) => { try { const { id, ...updateData } = params; const invoiceApiInstance = new cybersourceRestApi.InvoicesApi(visaClient.configuration, visaClient.visaApiClient); if (!updateData.customerInformation || !updateData.invoiceInformation || !updateData.orderInformation) { return 'Failed to update invoice: Missing required nested objects'; } if (!updateData.orderInformation.amountDetails || !updateData.orderInformation.amountDetails.totalAmount || !updateData.orderInformation.amountDetails.currency) { return 'Failed to update invoice: Missing required fields in orderInformation.amountDetails'; } const requestObj = { customerInformation: updateData.customerInformation, orderInformation: updateData.orderInformation, invoiceInformation: updateData.invoiceInformation }; const result = await new Promise((resolve, reject) => { invoiceApiInstance.updateInvoice(id, requestObj, (error: any, data: any) => { if (error) { reject(error); } else { resolve(data); } }); }); const maskedResult = maskInvoiceCustomerInfo(result); return maskedResult; } catch (error) { return 'Failed to update invoice'; } };
- Zod schema for input parameters of the update_invoice tool.export const updateInvoiceParameters = ( context: VisaContext = {} as VisaContext ) => { return z.object({ id: z.string().describe('Invoice ID (required)'), customerInformation: z.object({ email: z.string().optional().describe('Customer email (optional)'), name: z.string().optional().describe('Customer name (optional)') }).describe('Customer information object (required even if properties are optional)'), invoiceInformation: z.object({ description: z.string().optional().describe('Invoice description (required)'), dueDate: z.string().optional().describe('Due date (required)'), allowPartialPayments: z.boolean().optional().describe('Whether to allow partial payments (optional)'), deliveryMode: z.string().optional().describe('Delivery mode (optional)') }).describe('Invoice information object (required even if properties are optional)'), orderInformation: z.object({ amountDetails: z.object({ totalAmount: z.string().describe('Total amount (required)'), currency: z.string().describe('Currency code (required)'), discountAmount: z.string().optional().describe('Discount amount (optional)'), discountPercent: z.number().optional().describe('Discount percent (optional)'), subAmount: z.number().optional().describe('Sub amount (optional)'), minimumPartialAmount: z.number().optional().describe('Minimum partial amount (optional)') }).describe('Amount details object (required with totalAmount and currency)') }).describe('Order information object (required)') }); };
- typescript/src/shared/invoices/updateInvoice.ts:92-105 (registration)Tool module definition exporting the update_invoice tool object with method, description, parameters, and execute reference.const tool = (context: VisaContext): Tool => ({ method: 'update_invoice', name: 'Update Invoice', description: updateInvoicePrompt(context), parameters: updateInvoiceParameters(context), actions: { invoices: { update: true, }, }, execute: updateInvoice, }); export default tool;
- typescript/src/shared/tools.ts:40-53 (registration)Registration of all tools including updateInvoiceToolModule in the central createTools function.export function createTools(context: VisaContext): Tool[] { return [ createInvoiceToolModule(context), updateInvoiceToolModule(context), getInvoiceToolModule(context), listInvoicesToolModule(context), sendInvoiceToolModule(context), cancelInvoiceToolModule(context), createPaymentLinkToolModule(context), updatePaymentLinkToolModule(context), getPaymentLinkToolModule(context), listPaymentLinkToolModule(context) ]; }