AI Prompt Guidelines

​

Best Practices

​

Be Specific

• Dates (e.g., “dated January 15, 2024” or “dated today”)
• Amounts (e.g., “$1,000” or “500.00”)
• Contacts (e.g., “for customer ABC Company”)
• Descriptions (e.g., “for web development services”)

​

Use Natural Language

​

Include Context

​

Specify Dates

• “dated today”
• “dated January 15, 2024”
• “due in 30 days”

​

Good Examples

{
  "prompt": "Create an invoice for ABC Company for $1,000 for web development services, dated today, due in 30 days"
}

{
  "prompt": "Create a bill from XYZ Supplier for $500 for office supplies, dated January 15, 2024"
}

{
  "prompt": "Create an expense for $50 for lunch meeting with John Doe on January 20, 2024"
}

{
  "prompt": "Create a contact for John Smith, email john@example.com, phone +1234567890, customer type"
}

{
  "prompt": "Import: 01/15/2024 -45.99 Uber; 01/16/2024 +2000.00 ACH Payroll ACME; include dates, amounts, debit/credit or +/-, narration, and references",
  "bank": "your-bank-uuid"
}

​

Bad Examples

{
  "prompt": "Create invoice"
}

{
  "prompt": "Bill"
}

{
  "prompt": "Expense $50"
}

​

Tips

• Amounts in prompts: Natural language can include $ or plain numbers; in structured JSON bodies (e.g. payments), send numeric amounts without currency symbols unless an endpoint documents otherwise.
• Dates: Be explicit in prompts; structured bodies use YYYY-MM-DD where required.
• Contacts: Include names, emails, or phone numbers when relevant.
• Bank upload: POST /bank-transactions/upload requires prompt — describe or paste lines clearly. Optional attachments carry statement files.
• process_type: Use async for background processing (default on most AI creates) or direct when you need the result in the same HTTP response — see Concepts.