Skip to main content

Overview

Invoice tools provide full CRUD operations, approval workflow, payment processing, and email capabilities for accounts receivable.

CRUD Tools

finance_invoice_create

Create a new customer invoice. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesUnique invoice ID
customer_idstringYesCustomer ID
ar_account_idstringYesAR account ID
tran_datestringYesTransaction date
due_datestringYesPayment due date
posting_period_idstringYesAccounting period
currencystringNoCurrency code (default: USD)
memostringNoInvoice description
linesarrayYesInvoice line items

finance_invoice_get

Retrieve an invoice by ID. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID

finance_invoice_list

List invoices with filters. Parameters:
ParameterTypeRequiredDescription
statusstringNoFilter by status
customer_idstringNoFilter by customer
start_datestringNoFilter by date
end_datestringNoFilter by date
overduebooleanNoOnly overdue invoices

finance_invoice_update

Update a draft invoice. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
due_datestringNoUpdated due date
memostringNoUpdated memo
linesarrayNoUpdated lines

finance_invoice_delete

Delete a draft invoice. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID

Workflow Tools

finance_invoice_submit

Submit an invoice for approval. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
idempotency_keystringNoPrevent duplicates

finance_invoice_approve_l1

Level 1 approval. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
commentsstringNoApproval comments
idempotency_keystringNoPrevent duplicates

finance_invoice_approve_l2

Level 2 approval. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
commentsstringNoApproval comments
idempotency_keystringNoPrevent duplicates

finance_invoice_reject

Reject an invoice. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
reasonstringYesRejection reason

finance_invoice_request_change

Request changes to an invoice. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
commentsstringYesRequested changes

finance_invoice_hold

Place an invoice on hold. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
reasonstringNoHold reason

finance_invoice_unhold

Remove an invoice from hold. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID

Communication Tools

finance_invoice_send

Send an invoice to the customer via email. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
emailstringNoOverride email address
messagestringNoCustom email message

Payment Tools

finance_invoice_receive_payment

Record a payment received for an invoice. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
deposit_account_idstringYesBank account ID
payment_datestringYesPayment date
amountnumberYesPayment amount
payment_methodstringNoPayment method
referencestringNoPayment reference

finance_invoice_payment_get

Get payment details. Parameters:
ParameterTypeRequiredDescription
payment_idstringYesPayment ID

finance_invoice_payment_list

List payments for an invoice. Parameters:
ParameterTypeRequiredDescription
invoice_idstringNoFilter by invoice
customer_idstringNoFilter by customer
statusstringNoFilter by status

finance_invoice_payment_void

Void an invoice payment. Parameters:
ParameterTypeRequiredDescription
payment_idstringYesPayment ID
reasonstringYesVoid reason

finance_invoice_void

Void an invoice. Parameters:
ParameterTypeRequiredDescription
invoice_idstringYesInvoice ID
reasonstringYesVoid reason