Skip to content

Aimsio API (1.0.0)

Introduction

Aimsio provides a set of API endpoints and supported actions to facilitate communication with external software platforms / ERPs.

Each Aimsio account can access two server options: sandbox and portal

  • sandbox is the test environment we used to implement and test configuration changes for an account before live deployment.

  • portal is the live environment where accounts store their live transactions

Authentication

Our API utilizes basic username and password authentication to access the API.

If you already have an Admin username set up for your account inside Aimsio, this can be used for API authentication. However, the best practice would be to set up a separate user for integration purposes and keep this set of credentials private only to the developer.

Aimsio users also require specific permissions to access our API. Please contact our support/integration team so they can enable the required permissions.

Throughput limitation

We currently limit API calls after calls exceed more than 10 calls per second. If our API receives too many requests (ie: if the queue takes longer than 5 seconds to return the call), the request will timeout.

Up to 10 parallel calls are permitted. We do not limit the number of sequential calls. If your organization requires more headroom to complete calls to our API, please get in touch with us.

Usage - Querying data

For most entities with GET requests supported, there are two endpoints we supported:

  • GET all objects of that type

  • GET one speficic object based on its unique identifier (GUID/Id)

When you send a GET all request, the system will return an JSON array, and each JSON contains the following properties:

  • dtype: The object type

  • guid/id: Unique identifier of the object, generated by the Aimsio system

  • updatedAt: Object's last update timestamp in epoch millseconds

Using the returned Guid or ID, you can then query each specific object from the GET single request.

Usage - Posting data

To upload data, please review the object properties and example requests for each POST endpoint.

For our Master Data endpoints, you can create/edit new entries into Aimsio system.

For some other endpoints like Invoice or Timecard, we don't allow POSTing new entries, but updating status of existing entries are supported.

Object types like NRBs or Crew/Equipment records are included in the JobOrder GET response, but have to be POSTed through their own endpoints.

  • Crew records: Employee endpoint

  • Equipment records: Equipment endpoint

  • NRB records: NRB endpoint

Download OpenAPI description
aimsio_api.json
aimsio_api.yaml
Languages
Servers
Mock server

https://api.aimsio.com/_mock/aimsio_api/

Sandbox

https://sandbox.aimsio.com/

Production

https://portal.aimsio.com/

Master Data

Operations

Job Orders

Operations

Transactions

Operations

Payroll Period

Request

Update payroll period(s) status by provided GUID

Security
basicAuth
Bodyapplication/json
payrollPeriodListArray of objects(PayrollPeriod)
curl -i -X POST \
  -u <username>:<password> \
  https://api.aimsio.com/_mock/aimsio_api/rest/api/standard/v1/PayrollPeriod \
  -H 'Content-Type: application/json' \
  -d '{
    "payrollPeriodList": [
      {
        "payrollPeriodGuid": "8ac77eba-8a89-4f14-8ed1-2f57e4ec3ff1",
        "payrollPeriodStatus": "EXPORTED"
      }
    ]
  }'

Responses

Bodyapplication/json
dtypestring
Default "IntegrationImportResult"
idinteger
guidstring
importConfigurationstring
numberOfEntitiesCreatedinteger
numberOfEntitiesEditedinteger
numberOfEntitiesEditedWithErrorsinteger
numberOfEntitiesNotImportedDueToErrorsinteger
extrastring
noticesArray of objects
updatedAtinteger
importResultTypestring
numberOfEntitiesImportedinteger
Response
application/json
{
  "dtype": "IntegrationImportResult",
  "id": 0,
  "guid": "4b3f8eef-4307-4068-ba88-9ef491945122",
  "importConfiguration": null,
  "numberOfEntitiesCreated": 0,
  "numberOfEntitiesEdited": 1,
  "numberOfEntitiesEditedWithErrors": 0,
  "numberOfEntitiesNotImportedDueToErrors": 0,
  "extra": null,
  "notices": [],
  "updatedAt": 1746815305412,
  "importResultType": null,
  "numberOfEntitiesImported": 1
}

All Payroll Periods

Request

Retrieve all payroll periods in an account

Security
basicAuth
Query
statusstring

Status of the pay periods. Must be a valid payrollPeriodStatus value

limitnumber

Quantity of pay periods returned in the response. Default to 1000 if not specified

startnumber

Start index of the returned pay period. Default to 0 if not specified

curl -i -X GET \
  -u <username>:<password> \
  'https://api.aimsio.com/_mock/aimsio_api/rest/api/standard/v1/PayrollPeriod?status=string&limit=0&start=0'

Responses

OK

Bodyapplication/json
metaobject
paginationobject
dataArray of objects(PayrollPeriod)
Response
application/json
{
  "meta": {},
  "pagination": {
    "totalCount": 3,
    "limit": 1000
  },
  "data": [
    { … },
    { … },
    { … }
  ]
}

Payroll Period Timecards

Request

Retrieve all timecards in a pay period by provided period GUID

Security
basicAuth
Query
payrollPeriodGuidstring
Examples:
payrollPeriodGuid={{payrollPeriodGuid}}
limitnumber

Quantity of timecards returned in the response. Default to 1000 if not specified

startnumber

Start index of the returned timecard. Default to 0 if not specified

curl -i -X GET \
  -u <username>:<password> \
  'https://api.aimsio.com/_mock/aimsio_api/rest/api/standard/v1/TimeCard?payrollPeriodGuid={{payrollPeriodGuid}}&limit=0&start=0'

Responses

Successful response

Bodyapplication/json
metaobject
paginationobject
dataArray of objects(Timecard)
Response
application/json
{
  "meta": {},
  "pagination": {
    "totalCount": 4,
    "limit": 1000
  },
  "data": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Users

Operations