API Objects

Key Information

  • Field Sizes:
    • Primary Code fields: 20 characters
    • Name field: 100 characters
  • Request Method: All API methods use POST.
  • Response Format: All responses are in JSON format.
  • Attachments & Receipts: Provided as a stream format in the header record.
  • Session Binding: Login sessions are bound to the server’s API address.
  • Structure: API objects are organized similarly to the Admin Module.

API Object Organization

Core Organizational Structures:

  • Organization
  • Location
  • Employee Type
  • Operating Unit
  • Department
  • Employee

Work Breakdown Structure (WBS):

  • Main WBS
    • Level 1
    • Level 2
    • Level 3
    • Level 4
  • Assignment

Time and Payroll:

  • Time
  • Pay Code Group
  • Pay Code
  • Pay Code Assignments
  • Lock Period

Expense Management:

  • Expense
  • Report Type
  • Report Type Assignment
  • Additional Fields
  • Expense Type
  • Expense Type Assignments

Utilities and Searches:

  • Timesheet Search Utility
  • Expense Search Utility
  • Missing Timesheets

Transactions:

  • Vendor Payment Transactions
  • Credit Card Transactions
  • Prepaid Transactions
  • Cash Advances

Data Piping:

  • Import Profile
  • Export Profile
  • Post Timesheets Profile
  • Post Expenses Profile
  • Other Custom Profiles