API docs by Redocly

Zirius API (1.0)

Download OpenAPI specification:

APIs for communicating with Zirius+

Authentication

Operations related to authentication

Get Access Token

Provides Access token for given Api Key & Secret Key

header Parameters
Api-Key
required
string

Api Key of the user

Secret-Key
required
string

Secret Key of the user

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "accessToken": {
    }
}

Ledger Transactions

Operations related to Ledger

Update Ledger

Updates the ledger with given details and document

Authorizations:
bearerAuth
Request Body schema: application/json
required
date
string <date-time>
description
string
totalAmount
number
documentFormat
string
documentContent
string
Array of objects (LedgerLine)
documentId
string
companyId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "totalAmount": 0,
  • "documentFormat": "string",
  • "documentContent": "string",
  • "lines": [
    ],
  • "documentId": "string",
  • "companyId": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Update Ledger for Rubic

Updates the ledger with given details for Rubic

Authorizations:
bearerAuth
Request Body schema: application/json
required
settlementKey
string
settlementComplete
boolean
reconciliationStatusID
integer <int32>
startPeriod
string <date-time>
endPeriod
string <date-time>
expectedPayoutDate
string <date-time>
paidAmount
number
feeAmount
number
feeVatAmount
number
payoutAmount
number
transactionType
integer <int32>
transactionTypeName
string
Array of objects (GrossTransactionDto)

Responses

Request samples

Content type
application/json
{
  • "settlementKey": "string",
  • "settlementComplete": true,
  • "reconciliationStatusID": 0,
  • "startPeriod": "2019-08-24T14:15:22Z",
  • "endPeriod": "2019-08-24T14:15:22Z",
  • "expectedPayoutDate": "2019-08-24T14:15:22Z",
  • "paidAmount": 0,
  • "feeAmount": 0,
  • "feeVatAmount": 0,
  • "payoutAmount": 0,
  • "transactionType": 0,
  • "transactionTypeName": "string",
  • "grossTransactions": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get Ledger Transactions

Provides Ledger transactions for a particular account number within given date range

Authorizations:
bearerAuth
query Parameters
accountNumber
required
integer <int32>

Account number for which you need entries

fromDate
required
string

From date in the form of yyyy-MM-dd

toDate
required
string

To date in the form of yyyy-MM-dd

projectId
string

Project Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "ledgerTransactionList": [
    ]
}

Get Document

Provides the Document's url

Authorizations:
bearerAuth
query Parameters
documentId
required
string

Id of the document you want to look

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "documentList": [
    ]
}

Get Balance Sheet

Provides balance sheet for the given date or between two dates

Authorizations:
bearerAuth
query Parameters
date
required
string

Date in the format of yyyy-MM-dd

toDate
string

Date in the format of yyyy-MM-dd

accountNumber
integer <int32>

Account number for which you need balance

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "balanceList": [
    ]
}

User

Fetch User with User id

Returns single User

Authorizations:
bearerAuth
path Parameters
id
required
string

User ID

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "companyUser": {
    }
}

Update User

updated and returns the given User

Authorizations:
bearerAuth
path Parameters
id
required
string

User id

Request Body schema: application/json
required
name
required
string
email
required
string
mobile
string
phone
string
id
string
object (Address)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "mobile": "string",
  • "phone": "string",
  • "id": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "companyUser": {
    }
}

Delete User with User Id

delete the User

Authorizations:
bearerAuth
path Parameters
id
required
string

User id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Fetch all the users

Returns list of users

Authorizations:
bearerAuth
query Parameters
search
string

string for search

count
required
integer <int64>

count denotes how many records need to fetch

offset
required
integer <int64>

offset denotes from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "companyUsers": [
    ]
}

Create User

create new User

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
email
required
string
mobile
string
phone
string
id
string
object (Address)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "mobile": "string",
  • "phone": "string",
  • "id": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "companyUser": {
    }
}

Delete users

Returns deleted list of users

Authorizations:
bearerAuth
query Parameters
ids
required
Array of strings [ 1 .. 2147483647 ] items

List of User ids

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Time Tracker

Fetch Time Entry

Return Time entry by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

time entry id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "timeEntry": {
    }
}

Update Time Entry

Update Time entry by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

time entry id

Request Body schema: application/json
required
id
integer <int64>
object (Order)
object (SalaryCode)
object (TimeEntryUser)
object (Customer)
object (Dimension)
object (Dimension)
object (Dimension)
object (Dimension)
companyId
integer <int64>
fromTime
string <date-time>
toTime
string <date-time>
createdDate
string <date-time>
modifiedDate
string <date-time>
quantity
number <double>
invoiceTime
number <double>
actualTime
number <double>
remarks
string
approved
integer <int32>
journalId
integer <int64>
discountPercent
number <double>
amount
number <double>
amountInclVat
number <double>
object (Dimension)
object (Dimension)
object (Dimension)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "order": {
    },
  • "salaryCode": {
    },
  • "user": {
    },
  • "customer": {
    },
  • "department": {
    },
  • "project": {
    },
  • "dimension1": {
    },
  • "dimension2": {
    },
  • "companyId": 0,
  • "fromTime": "2019-08-24T14:15:22Z",
  • "toTime": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "quantity": 0.1,
  • "invoiceTime": 0.1,
  • "actualTime": 0.1,
  • "remarks": "string",
  • "approved": 0,
  • "journalId": 0,
  • "discountPercent": 0.1,
  • "amount": 0.1,
  • "amountInclVat": 0.1,
  • "activity": {
    },
  • "section": {
    },
  • "asset": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "timeEntry": {
    }
}

Delete Time Entry

Delete Time entry by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

time entry id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Fetch Time entries

Returns list of time entries

Authorizations:
bearerAuth
query Parameters
count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

stage
string
Enum: "forApproval" "approved" "history"

filter by stage

salaryCodeId
string

filter by salary code id

fromDate
string

fromDate in dd-MM-yyyy format

toDate
string

toDate in dd-MM-yyyy format

projectId
string

filter by project

sortBy
string
Enum: "date" "salaryCode" "amount"

sorting field

sortType
string
Enum: "asc" "desc"

sorting type

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "timeEntries": [
    ],
  • "count": 0
}

Create time entry

Create new time entry

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
integer <int64>
object (Order)
object (SalaryCode)
object (TimeEntryUser)
object (Customer)
object (Dimension)
object (Dimension)
object (Dimension)
object (Dimension)
companyId
integer <int64>
fromTime
string <date-time>
toTime
string <date-time>
createdDate
string <date-time>
modifiedDate
string <date-time>
quantity
number <double>
invoiceTime
number <double>
actualTime
number <double>
remarks
string
approved
integer <int32>
journalId
integer <int64>
discountPercent
number <double>
amount
number <double>
amountInclVat
number <double>
object (Dimension)
object (Dimension)
object (Dimension)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "order": {
    },
  • "salaryCode": {
    },
  • "user": {
    },
  • "customer": {
    },
  • "department": {
    },
  • "project": {
    },
  • "dimension1": {
    },
  • "dimension2": {
    },
  • "companyId": 0,
  • "fromTime": "2019-08-24T14:15:22Z",
  • "toTime": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "quantity": 0.1,
  • "invoiceTime": 0.1,
  • "actualTime": 0.1,
  • "remarks": "string",
  • "approved": 0,
  • "journalId": 0,
  • "discountPercent": 0.1,
  • "amount": 0.1,
  • "amountInclVat": 0.1,
  • "activity": {
    },
  • "section": {
    },
  • "asset": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "timeEntry": {
    }
}

Delete Time Entries

Delete Time entries by id

Authorizations:
bearerAuth
query Parameters
ids
required
Array of integers <int64> [ 1 .. 2147483647 ] items [ items <int64 > ]

ID of time entries that needs to be deleted

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Supplier

Get supplier

Return single supplier

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

supplier Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "supplierDetails": {
    }
}

Update Supplier

Update supplier by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

supplier Id

Request Body schema: application/json
required
id
integer <int32>
name
string
object (Address)
organizationNumber
string
mobileNumber
string
telephoneNumber
string
email
string
object (Address)
object (PaymentCondition)
object (Currency)
object (DeliveryCondition)
object (DeliveryMethod)
vatCode
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": {
    },
  • "organizationNumber": "string",
  • "mobileNumber": "string",
  • "telephoneNumber": "string",
  • "email": "string",
  • "deliveryAddress": {
    },
  • "paymentCondition": {
    },
  • "currency": {
    },
  • "deliveryCondition": {
    },
  • "deliveryMethod": {
    },
  • "vatCode": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "supplierDetails": {
    }
}

Delete supplier

Delete supplier by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

supplier Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get suppliers list

Return all suppliers

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "suppliers": [
    ]
}

Create Supplier

Create a new supplier

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
integer <int32>
name
string
object (Address)
organizationNumber
string
mobileNumber
string
telephoneNumber
string
email
string
object (Address)
object (PaymentCondition)
object (Currency)
object (DeliveryCondition)
object (DeliveryMethod)
vatCode
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": {
    },
  • "organizationNumber": "string",
  • "mobileNumber": "string",
  • "telephoneNumber": "string",
  • "email": "string",
  • "deliveryAddress": {
    },
  • "paymentCondition": {
    },
  • "currency": {
    },
  • "deliveryCondition": {
    },
  • "deliveryMethod": {
    },
  • "vatCode": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "supplierDetails": {
    }
}

Section

Get section

Return single section

Authorizations:
bearerAuth
path Parameters
id
required
string

section Id

query Parameters
projectId
required
string

project id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "section": {
    }
}

Update Section

Update section by id

Authorizations:
bearerAuth
path Parameters
id
required
string

section Id

query Parameters
projectId
required
string

project id

Request Body schema: application/json
required
id
string
name
string
projectId
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "projectId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "section": {
    }
}

Delete section

Delete section by id

Authorizations:
bearerAuth
path Parameters
id
required
string

section Id

query Parameters
projectId
required
string

project id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get sections list

Return all sections

Authorizations:
bearerAuth
query Parameters
projectId
required
string

project id

search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "sections": [
    ]
}

Create Section

Create a new section

Authorizations:
bearerAuth
query Parameters
projectId
required
string

project id

Request Body schema: application/json
required
id
string
name
string
projectId
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "projectId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "section": {
    }
}

Salary

Get SalaryRun logs

Return all salary run logs

Authorizations:
bearerAuth
query Parameters
count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "salaryRunLogs": [
    ]
}

Update Salary run log as sync

Return all ledger account logs

Authorizations:
bearerAuth
query Parameters
ids
required
Array of integers <int64> [ items <int64 > ]

SalaryRun log ids

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "ledgerAccountLogs": [
    ]
}

Get Salary run reports

Return reports for salary run log

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

salary run log Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "salaryRunReportDetails": {
    }
}

Get Ledger account logs

Return all ledger account logs

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

salary run log Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "ledgerAccountLogs": [
    ]
}

Get Non sync SalaryRun logs

Return all non sync salary run logs

Authorizations:
bearerAuth
query Parameters
count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "salaryRunLogs": [
    ]
}

Project

Get project

Return single project

Authorizations:
bearerAuth
path Parameters
id
required
string

project Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "project": {
    }
}

Update Project

Update project by id

Authorizations:
bearerAuth
path Parameters
id
required
string

project Id

Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "project": {
    }
}

Delete project

Delete project by id

Authorizations:
bearerAuth
path Parameters
id
required
string

project Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get projects list

Return all projects

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "projects": [
    ]
}

Create Project

Create a new project

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "project": {
    }
}

Payment Method

Get Payment Method

Return single Payment Method

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

paymentMethod Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "paymentMethod": {
    }
}

Update Payment Method

Update Payment Method by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

paymentMethod Id

Request Body schema: application/json
required
id
integer <int32>
name
string
standard
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "standard": true
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "paymentMethod": {
    }
}

Delete Payment Method

Delete paymentMethod by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

paymentMethod Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Fetch Payment Methods

Return all payment methods

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "paymentMethods": [
    ]
}

Create Payment Method

Create a new Payment Method

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
integer <int32>
name
string
standard
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "standard": true
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "paymentMethod": {
    }
}

Payment Condition

Get Payment Condition

Return single Payment Condition

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

paymentCondition Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "paymentCondition": {
    }
}

Update Payment Condition

Update Payment Condition by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

paymentCondition Id

Request Body schema: application/json
required
id
integer <int32>
name
string
noOfDays
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "noOfDays": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "paymentCondition": {
    }
}

Delete Payment Condition

Delete Payment Condition by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

paymentCondition Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Fetch Payment Conditions

Return all payment conditions

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "paymentConditions": [
    ]
}

Create Payment Condition

Create a new Payment Condition

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
integer <int32>
name
string
noOfDays
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "noOfDays": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "paymentCondition": {
    }
}

Order

Finds the order which matches {orderId}

Returns a single order

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32>

ID of order to return

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "order": {
    }
}

Update order

Update order

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32>

order id

Request Body schema: application/json
required
id
integer <int32>
orderDate
string <date-time>
deliveryDate
string <date-time>
invoiceDate
string <date-time>
object (DeliveryMethod)
vatCode
integer <int32>
orderNumber
integer <int32>
name
string
customerId
integer <int32>
amount
number
amountIncludingVat
number
customerReference
string
object (Currency)
linesCount
integer <int32>
object (OrderType)
ourRef
string
object (Address)
object (Address)
object (DeliveryCondition)
Array of objects (OrderLine)
object (PaymentMethod)
object (PaymentCondition)
poNumber
string
customerEmail
string
mobileNo
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "orderDate": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "deliveryMethod": {
    },
  • "vatCode": 0,
  • "orderNumber": 0,
  • "name": "string",
  • "customerId": 0,
  • "amount": 0,
  • "amountIncludingVat": 0,
  • "customerReference": "string",
  • "currency": {
    },
  • "linesCount": 0,
  • "orderType": {
    },
  • "ourRef": "string",
  • "deliveryAddress": {
    },
  • "invoiceAddress": {
    },
  • "deliveryCondition": {
    },
  • "orderLines": [
    ],
  • "paymentMethod": {
    },
  • "paymentCondition": {
    },
  • "poNumber": "string",
  • "customerEmail": "string",
  • "mobileNo": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "order": {
    }
}

Delete Order

Delete Order by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32>

Order id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Fetch Orders with basic info

Returns an array of Orders

Authorizations:
bearerAuth
query Parameters
count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

stage
string
Enum: "pending" "forApproval" "finalized"

filter by stage

customerId
string

filter by customer id

fromDate
string

fromDate in dd-MM-yyyy format

toDate
string

toDate in dd-MM-yyyy format

deliveryMethodId
string

filter by delivery method

sortBy
string
Enum: "orderDate" "amount" "orderNo"

sorting field

sortType
string
Enum: "asc" "desc"

sorting type

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "orders": [
    ],
  • "count": 0
}

Create order

Create a new order

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
integer <int32>
orderDate
string <date-time>
deliveryDate
string <date-time>
invoiceDate
string <date-time>
object (DeliveryMethod)
vatCode
integer <int32>
orderNumber
integer <int32>
name
string
customerId
integer <int32>
amount
number
amountIncludingVat
number
customerReference
string
object (Currency)
linesCount
integer <int32>
object (OrderType)
ourRef
string
object (Address)
object (Address)
object (DeliveryCondition)
Array of objects (OrderLine)
object (PaymentMethod)
object (PaymentCondition)
poNumber
string
customerEmail
string
mobileNo
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "orderDate": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "deliveryMethod": {
    },
  • "vatCode": 0,
  • "orderNumber": 0,
  • "name": "string",
  • "customerId": 0,
  • "amount": 0,
  • "amountIncludingVat": 0,
  • "customerReference": "string",
  • "currency": {
    },
  • "linesCount": 0,
  • "orderType": {
    },
  • "ourRef": "string",
  • "deliveryAddress": {
    },
  • "invoiceAddress": {
    },
  • "deliveryCondition": {
    },
  • "orderLines": [
    ],
  • "paymentMethod": {
    },
  • "paymentCondition": {
    },
  • "poNumber": "string",
  • "customerEmail": "string",
  • "mobileNo": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "order": {
    }
}

Delete Orders

Delete Orders by id

Authorizations:
bearerAuth
query Parameters
ids
required
Array of integers <int32> [ 1 .. 2147483647 ] items [ items <int32 > ]

ID of time entries that needs to be deleted

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

update order status

Update order status by order Id and status id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int32>

Order Id

query Parameters
orderTypeId
required
integer <int32>

Order type id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Expense Claim

Finds the expense which matches {expenseId}

Returns a single expense

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of expense to return

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "expense": {
    }
}

Updates the expense which matches {expenseId}

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of the expense that needs to be updated.

Request Body schema: application/json
required
isGroup
boolean
fromDate
string <date-time>
toDate
string <date-time>
parentId
string
id
string
amount
required
number <double>
expenseDate
string <date-time>
createdDate
string <date-time>
notes
string
name
string
isActive
boolean
hasAttachments
boolean
status
string
object (ExpenseType)
object (User)
object (Currency)
object (Dimension)
object (Dimension)
object (Dimension)
object (Dimension)
object (Dimension)
object (Dimension)
Array of objects (AttestationUsers)
object (AttestationUsers)
Array of objects (Label)
expenseStageId
integer <int64>
expenseStatusId
integer <int64>
isAttestationCycleStarted
boolean
object (Company)
Array of objects (Attachment)
object (ExpensePaymentType)

Responses

Request samples

Content type
application/json
{
  • "isGroup": true,
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "parentId": "string",
  • "id": "string",
  • "amount": 12,
  • "expenseDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "notes": "Plane tickets",
  • "name": "expense name",
  • "isActive": true,
  • "hasAttachments": true,
  • "status": "Inbox",
  • "expenseType": {
    },
  • "user": {
    },
  • "currency": {
    },
  • "activity": {
    },
  • "section": {
    },
  • "department": {
    },
  • "project": {
    },
  • "dimension1": {
    },
  • "dimension2": {
    },
  • "attestationUsers": [
    ],
  • "currentAuthority": {
    },
  • "labels": [
    ],
  • "expenseStageId": 0,
  • "expenseStatusId": 0,
  • "isAttestationCycleStarted": true,
  • "company": {
    },
  • "attachments": [
    ],
  • "expensePaymentType": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "expense": {
    }
}

delete the expense which matches {expenseId}

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of expense that needs to be deleted

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Returns list of Expenses with basic information

Returns an array of Expenses

Authorizations:
bearerAuth
query Parameters
count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

stage
string
Enum: "Inbox" "Accepted" "AtAccountingOffice" "History" "Attestation" "Rejected" "Finalized"

filter by stage

expenseType
string

filter by expense type

fromDate
string

fromDate in dd-MM-yyyy format

toDate
string

toDate in dd-MM-yyyy format

paymentType
string

filter by payment type

sortBy
string
Enum: "date" "amount"

sorting field

sortType
string
Enum: "asc" "desc"

sorting type

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "expenses": [
    ],
  • "count": 0
}

Adds an expense item

Adds an expense item to the system

Authorizations:
bearerAuth
Request Body schema: application/json
required
isGroup
boolean
fromDate
string <date-time>
toDate
string <date-time>
parentId
string
id
string
amount
required
number <double>
expenseDate
string <date-time>
createdDate
string <date-time>
notes
string
name
string
isActive
boolean
hasAttachments
boolean
status
string
object (ExpenseType)
object (User)
object (Currency)
object (Dimension)
object (Dimension)
object (Dimension)
object (Dimension)
object (Dimension)
object (Dimension)
Array of objects (AttestationUsers)
object (AttestationUsers)
Array of objects (Label)
expenseStageId
integer <int64>
expenseStatusId
integer <int64>
isAttestationCycleStarted
boolean
object (Company)
Array of objects (Attachment)
object (ExpensePaymentType)

Responses

Request samples

Content type
application/json
{
  • "isGroup": true,
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "parentId": "string",
  • "id": "string",
  • "amount": 12,
  • "expenseDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "notes": "Plane tickets",
  • "name": "expense name",
  • "isActive": true,
  • "hasAttachments": true,
  • "status": "Inbox",
  • "expenseType": {
    },
  • "user": {
    },
  • "currency": {
    },
  • "activity": {
    },
  • "section": {
    },
  • "department": {
    },
  • "project": {
    },
  • "dimension1": {
    },
  • "dimension2": {
    },
  • "attestationUsers": [
    ],
  • "currentAuthority": {
    },
  • "labels": [
    ],
  • "expenseStageId": 0,
  • "expenseStatusId": 0,
  • "isAttestationCycleStarted": true,
  • "company": {
    },
  • "attachments": [
    ],
  • "expensePaymentType": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "expense": {
    }
}

delete the expense which matches {expenseId}

Authorizations:
bearerAuth
query Parameters
ids
required
Array of strings

ID of expense that needs to be deleted

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Upload attachment to CMS

Upload attachment to AWS S3 via CMS

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
fileName
string
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "attachment": {
    }
}

Returns list of expense payment types

Returns an array of objects where each object represents a expense payment type

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "paymentTypes": [
    ]
}

Returns list of Attachments with URL to download

Returns an array of Attachments

Authorizations:
bearerAuth
path Parameters
id
required
string

expense Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "attachments": [
    ]
}

Returns list of expense types

Returns an array of objects where each object represents a expense type

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "expenseTypes": [
    ]
}

Dimension2

Get dimension

Return single dimension

Authorizations:
bearerAuth
path Parameters
id
required
string

dimension Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "dimension": {
    }
}

Update Dimension

Update dimension by id

Authorizations:
bearerAuth
path Parameters
id
required
string

dimension Id

Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "dimension": {
    }
}

Delete dimension

Delete dimension by id

Authorizations:
bearerAuth
path Parameters
id
required
string

dimension Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get dimensions list

Return all dimensions

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "dimensions": [
    ]
}

Create Dimension

Create a new dimension

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "dimension": {
    }
}

Dimension1

Get dimension

Return single dimension

Authorizations:
bearerAuth
path Parameters
id
required
string

dimension Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "dimension": {
    }
}

Update Dimension

Update dimension by id

Authorizations:
bearerAuth
path Parameters
id
required
string

dimension Id

Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "dimension": {
    }
}

Delete dimension

Delete dimension by id

Authorizations:
bearerAuth
path Parameters
id
required
string

dimension Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get dimensions list

Return all dimensions

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "dimensions": [
    ]
}

Create Dimension

Create a new dimension

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "dimension": {
    }
}

Department

Get department

Return single department

Authorizations:
bearerAuth
path Parameters
id
required
string

department Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "department": {
    }
}

Update Department

Update department by id

Authorizations:
bearerAuth
path Parameters
id
required
string

department Id

Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "department": {
    }
}

Delete department

Delete department by id

Authorizations:
bearerAuth
path Parameters
id
required
string

department Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get departments list

Return all departments

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "departments": [
    ]
}

Create Department

Create a new department

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "department": {
    }
}

Delivery Method

Get Delivery Method

Return single Delivery Method

Authorizations:
bearerAuth
path Parameters
id
required
string

deliveryMethod Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "deliveryMethod": {
    }
}

Update Delivery Method

Update Delivery Method by id

Authorizations:
bearerAuth
path Parameters
id
required
string

deliveryMethod Id

Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "deliveryMethod": {
    }
}

Delete Delivery Method

Delete Delivery Method by id

Authorizations:
bearerAuth
path Parameters
id
required
string

deliveryMethod Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Fetch Delivery Methods

Return all delivery methods

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "deliveryMethods": [
    ]
}

Create Delivery Method

Create a new Delivery Method

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "deliveryMethod": {
    }
}

Delivery Condition

Get Delivery Condition

Return single Delivery Condition

Authorizations:
bearerAuth
path Parameters
id
required
string

deliveryCondition Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "deliveryCondition": {
    }
}

Update Delivery Condition

Update Delivery Condition by id

Authorizations:
bearerAuth
path Parameters
id
required
string

deliveryCondition Id

Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "deliveryCondition": {
    }
}

Delete Delivery Condition

Delete Delivery Condition by id

Authorizations:
bearerAuth
path Parameters
id
required
string

deliveryCondition Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Fetch Delivery Condition

Return all delivery conditions

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "deliveryConditions": [
    ]
}

Create Delivery Condition

Create a new Delivery Condition

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "deliveryCondition": {
    }
}

Customer

Get customer

Return single customer

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

customer Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "customerDetails": {
    }
}

Update Customer

Update customer by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

customer Id

Request Body schema: application/json
required
id
integer <int32>
name
string
object (Address)
organizationNumber
string
mobileNumber
string
telephoneNumber
string
email
string
object (Address)
object (PaymentMethod)
object (PaymentCondition)
object (Currency)
object (DeliveryCondition)
object (DeliveryMethod)
vatCode
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": {
    },
  • "organizationNumber": "string",
  • "mobileNumber": "string",
  • "telephoneNumber": "string",
  • "email": "string",
  • "deliveryAddress": {
    },
  • "paymentMethod": {
    },
  • "paymentCondition": {
    },
  • "currency": {
    },
  • "deliveryCondition": {
    },
  • "deliveryMethod": {
    },
  • "vatCode": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "customerDetails": {
    }
}

Delete customer

Delete customer by id

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

customer Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get customers list

Return all customers

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "customers": [
    ]
}

Create Customer

Create a new customer

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
integer <int32>
name
string
object (Address)
organizationNumber
string
mobileNumber
string
telephoneNumber
string
email
string
object (Address)
object (PaymentMethod)
object (PaymentCondition)
object (Currency)
object (DeliveryCondition)
object (DeliveryMethod)
vatCode
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": {
    },
  • "organizationNumber": "string",
  • "mobileNumber": "string",
  • "telephoneNumber": "string",
  • "email": "string",
  • "deliveryAddress": {
    },
  • "paymentMethod": {
    },
  • "paymentCondition": {
    },
  • "currency": {
    },
  • "deliveryCondition": {
    },
  • "deliveryMethod": {
    },
  • "vatCode": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "customerDetails": {
    }
}

Get delivery addresses list of customer

Return all delivery addresses of customer

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

customer Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "addresses": [
    ]
}

Get contact persons list of customer/supplier

Return all contact persons of customer/supplier

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

customer/supplier Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "contacts": [
    ]
}

Asset

Get asset

Return single asset

Authorizations:
bearerAuth
path Parameters
id
required
string

asset Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "asset": {
    }
}

Update Asset

Update asset by id

Authorizations:
bearerAuth
path Parameters
id
required
string

asset Id

Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "asset": {
    }
}

Delete asset

Delete asset by id

Authorizations:
bearerAuth
path Parameters
id
required
string

asset Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get assets list

Return all assets

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "assets": [
    ]
}

Create Asset

Create a new asset

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "asset": {
    }
}

Activity

Get activity

Return single activity

Authorizations:
bearerAuth
path Parameters
id
required
string

activity Id

query Parameters
projectId
required
string

Project id of activities

sectionId
required
string

Section id of activities

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "activity": {
    }
}

Update Activity

Update activity by id

Authorizations:
bearerAuth
path Parameters
id
required
string

activity Id

query Parameters
projectId
required
string

Project id of activities

sectionId
required
string

Section id of activities

Request Body schema: application/json
required
id
string
name
string
projectId
string
sectionId
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "projectId": "string",
  • "sectionId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "activity": {
    }
}

Delete activity

Delete activity by id

Authorizations:
bearerAuth
path Parameters
id
required
string

activity Id

query Parameters
projectId
required
string

Project id of activities

sectionId
required
string

Section id of activities

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ]
}

Get activities list

Return all activitys

Authorizations:
bearerAuth
query Parameters
projectId
required
string

Project id of activities

sectionId
required
string

Section id of activities

search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "activities": [
    ]
}

Create Activity

Create a new activity

Authorizations:
bearerAuth
query Parameters
projectId
required
string

Project id of activities

sectionId
required
string

Section id of activities

Request Body schema: application/json
required
id
string
name
string
projectId
string
sectionId
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "projectId": "string",
  • "sectionId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "activity": {
    }
}

General

Fetch Salary codes

Return all salary codes

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "salaryCodes": [
    ]
}

Fetch Order types

Return all order types

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "orderTypes": [
    ]
}

Product

Fetch products

Return all products

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "products": [
    ]
}

Get product

Return single product

Authorizations:
bearerAuth
path Parameters
id
required
string

product Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "productDetails": {
    }
}

Get Documents

Provides the Document's in url

Authorizations:
bearerAuth
path Parameters
id
required
string

product Id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "documentList": [
    ]
}

Fetch product Groups

Return all product groups

Authorizations:
bearerAuth
query Parameters
search
required
string

string for search

count
required
integer <int64>

denotes how many records need to fetch

offset
required
integer <int64>

offset from where to fetch records

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "productGroups": [
    ]
}

Currency

Returns list of currencies

Returns an array of objects where each object represents a currency

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "currencies": [
    ]
}

Company

Get company Info

Returns the details of company

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "messageArgs": [
    ],
  • "company": {
    }
}