API docs by Redocly

AbaNinja API (2.0.4)

Download OpenAPI specification:Download

ABACUS Research AG: [email protected] URL: https://www.abacus.ch License: MIT

This is the AbaNinja API documentation

Addresses

Manage addresses

Check if the customerNumber already in use or not

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
query Parameters
customerNumber
required
string

The customer number to check

addressUuid
string <uuid>

The address UUID to ignore for this check

Responses

Get a list of company addresses for given account

This return a list of available company addresses for the given account

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
query Parameters
page
integer <int64>
limit
integer <int64>
tags[]
Array of strings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Single company

Returns data for one company only

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
companyUuid
required
string <uuid>

The id of the address

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Single company update

Updates single company

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
companyUuid
required
string <uuid>

The id of the address

Request Body schema: application/json

Addressfields to update

type
required
string
Value: "company"
uuid
required
string <uuid>
customer_number
string
name
required
string
id_number
string
vat_number
string
currency_code
string
language
string
Array of objects (AddressesContactPerson)
tags
Array of strings
Array of objects (AddressesContact)
Array of objects (AddressesAddress)
private_notes
string
automatic_dunning
boolean
payment_terms
integer
Enum: -1 7 10 14 15 20 30 60 90

Responses

Request samples

Content type
application/json
{
  • "type": "company",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer_number": "string",
  • "name": "string",
  • "id_number": "string",
  • "vat_number": "string",
  • "currency_code": "string",
  • "language": "string",
  • "contact_persons": [
    ],
  • "tags": [
    ],
  • "contacts": [
    ],
  • "addresses": [
    ],
  • "private_notes": "string",
  • "automatic_dunning": true,
  • "payment_terms": -1
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Delete company

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
companyUuid
required
string <uuid>

The id of the address

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Get a list of person addresses for given account

This return a list of available company addresses for the given account

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
query Parameters
page
integer <int64>
limit
integer <int64>
tags[]
Array of strings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Single person access

Returns data for one company only

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
personUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Single person update

Updates single person

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
personUuid
required
string <uuid>
Request Body schema: application/json

Addressfields to update

type
required
string
Value: "person"
uuid
required
string <uuid>
first_name
required
string
last_name
required
string
salutation
string
Enum: "Mr" "Ms" "Family"
currency_code
string
language
string
Array of objects (AddressesContact)
tags
Array of strings
Array of objects (AddressesAddress)
private_notes
string
automatic_dunning
boolean
payment_terms
integer
Enum: -1 7 10 14 15 20 30 60 90

Responses

Request samples

Content type
application/json
{
  • "type": "person",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "first_name": "string",
  • "last_name": "string",
  • "salutation": "Mr",
  • "currency_code": "string",
  • "language": "string",
  • "contacts": [
    ],
  • "tags": [
    ],
  • "addresses": [
    ],
  • "private_notes": "string",
  • "automatic_dunning": true,
  • "payment_terms": -1
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Delete person

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
personUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Create new address for given account

Creating a new address in AbaNinja

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
query Parameters
force
boolean

Force saving of Address. Even when duplicates were found. Default: false

Request Body schema: application/json

New Address

One of
type
required
string
Value: "company"
customer_number
string
name
required
string
id_number
string
vat_number
string
currency_code
string
language
string
Array of objects (AddressesContactBody)
tags
Array of strings
Array of objects (AddressesContactPersonBody)
Array of objects (AddressesAddressBody)
private_notes
string
automatic_dunning
boolean
payment_terms
integer
Enum: -1 7 10 14 15 20 30 60 90

Responses

Request samples

Content type
application/json
Example
{
  • "type": "company",
  • "customer_number": "string",
  • "name": "string",
  • "id_number": "string",
  • "vat_number": "string",
  • "currency_code": "string",
  • "language": "string",
  • "contacts": [
    ],
  • "tags": [
    ],
  • "contact_persons": [
    ],
  • "addresses": [
    ],
  • "private_notes": "string",
  • "automatic_dunning": true,
  • "payment_terms": -1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

DocumentsQuotes

Manage Quotes

Quotes List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
updatedSince
string or null <date>
limit
integer or null
page
integer or null

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create a quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the quote should be created

Request Body schema: application/json
required
Array of objects (singleQuote) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of quote

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update a quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the quote should be created

documentUuid
required
string <uuid>

UUID of quote

Request Body schema: application/json
required
Array of objects (singleQuote) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of quote

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of quote

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsContractNotes

Manage Contract Notes

Contract Notes List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
updatedSince
string or null <date>
limit
integer or null
page
integer or null

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the contract note should be created

Request Body schema: application/json
required
Array of objects (singleContractNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the contract note should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
required
Array of objects (singleContractNote) non-empty

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract note

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsDeliveryNotes

Manage Delivery Notes

Delivery Notes List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
updatedSince
string or null <date>
limit
integer or null
page
integer or null

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the delivery note should be created

Request Body schema: application/json
required
Array of objects (singleDeliveryNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the delivery note should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
required
Array of objects (singleDeliveryNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of delivery note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of delivery note

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsInvoices

Manage Invoices

Invoices List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
updatedSince
string or null <date>
limit
integer or null
page
integer or null

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the invoice should be created

Request Body schema: application/json
required
Array of objects (singleInvoice) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the invoice should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
required
Array of objects (singleInvoice) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of invoice

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of invoice

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsInvoicesImported

Manage Invoices (Existing PDF)

Create an imported invoice (PDF existing)

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the invoice should be imported to

Request Body schema: application/json
required
Array of objects (singleDocument) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

DocumentsCreditNotes

Manage Credit Notes

Credit Notes List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
updatedSince
string or null <date>
limit
integer or null
page
integer or null

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the credit note should be created

Request Body schema: application/json
required
Array of objects (singleCreditNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the credit note should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
required
Array of objects (singleCreditNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of credit note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of credit note

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsRecurringInvoices

Manage Recurring Invoices

Recurring Invoices List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
updatedSince
string or null <date>
limit
integer or null
page
integer or null

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the recurring invoice should be created

Request Body schema: application/json
required
Array of objects (singleRecurringInvoice) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the recurring invoice should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
required
Array of objects (singleRecurringInvoice) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of recurring invoice

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of recurring invoice

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsTemplates

Manage Templates

Templates List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
updatedSince
string or null <date>
limit
integer or null
page
integer or null

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create template

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the template should be created

Request Body schema: application/json
required
Array of objects (singleTemplate) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing template

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update template

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the template should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
required
Array of objects (singleTemplate) non-empty

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

List template actions

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of template

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing template

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of template

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsReceipts

Manage Receipts

Receipts List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
updatedSince
string or null <date>
limit
integer or null
page
integer or null

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Actions for an existing receipt

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of receipt

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing receipt

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of receipt

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsQueue

Check queue

Existing queue

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

queueUuid
required
string <uuid>

UUID of the queue to get status from

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

FinancesBankAccounts

Manage bank accounts

List of bank accounts

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the bank accounts are located

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create bank account

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the bank accounts are located

Request Body schema: application/json
One of
name
required
string [ 1 .. 255 ] characters
bankName
string <= 255 characters
bankAddress
string <= 255 characters
bankCity
string <= 255 characters

postal code & town of the bank institute

iban
required
string^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$
bic
required
string^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$
currencyCode
required
string^[A-Z]{3}$
object
isActive
boolean
Default: true

Activate/Deactivate bank account for usage in AbaNinja. Default: active

isDefault
boolean
Default: false

Set if bank account should be used as default.

Responses

Request samples

Content type
application/json
{
  • "name": "My Bank",
  • "bankName": "Test Bank",
  • "bankAddress": "Postfach",
  • "bankCity": "1234 Musterhausen",
  • "iban": "CH1343452R2763M55N06W",
  • "bic": "KBTGCH22XXX",
  • "currencyCode": "CHF",
  • "qrBill": {
    },
  • "isActive": true,
  • "isDefault": false
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Single bank account

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the bank account is located

bankAccountUuid
required
string <uuid>

UUID of bank account

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update bank account

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the bank account is located

bankAccountUuid
required
string <uuid>

UUID of bank account

Request Body schema: application/json
One of
name
required
string [ 1 .. 255 ] characters
bankName
string <= 255 characters
bankAddress
string <= 255 characters
bankCity
string <= 255 characters

postal code & town of the bank institute

iban
required
string^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$
bic
required
string^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$
currencyCode
required
string^[A-Z]{3}$
object
isActive
boolean
Default: true

Activate/Deactivate bank account for usage in AbaNinja. Default: active

isDefault
boolean
Default: false

Set if bank account should be used as default.

Responses

Request samples

Content type
application/json
{
  • "name": "My Bank",
  • "bankName": "Test Bank",
  • "bankAddress": "Postfach",
  • "bankCity": "1234 Musterhausen",
  • "iban": "CH1343452R2763M55N06W",
  • "bic": "KBTGCH22XXX",
  • "currencyCode": "CHF",
  • "qrBill": {
    },
  • "isActive": true,
  • "isDefault": false
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Remove bank account

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the bank account is located

bankAccountUuid
required
string <uuid>

UUID of bank account

Responses

Products

Manage Products

Products List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

query Parameters
limit
integer

The limit per page

page
integer

The page number

isArchived
boolean

Get products which are archived or not

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create a new product

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the product should be created

Request Body schema: application/json
productKey
required
string <= 30 characters
productGroupNumber
null or number
isService
required
boolean
tags
Array of strings
required
object
Array of objects
eanCode
null or string <= 13 characters
unitUuid
required
string <uuid>
cost
required
number
taxRate
null or number
bookingAccountNumber
null or string

Responses

Request samples

Content type
application/json
{
  • "productKey": "P0123-456",
  • "productGroupNumber": "44",
  • "isService": true,
  • "tags": [
    ],
  • "translations": {
    },
  • "properties": [
    ],
  • "eanCode": "5234816352132",
  • "unitUuid": "4ea8f502-b003-41e6-a190-c2ae59ac4f26",
  • "cost": 72.5,
  • "taxRate": 7.7,
  • "bookingAccountNumber": 2540
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Get an existing product

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

productUuid
required
string <uuid>

UUID of the product to get

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update an existing product

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the product should be created

productUuid
required
string <uuid>

UUID of the product to update

Request Body schema: application/json
productKey
required
string <= 30 characters
productGroupNumber
null or number
isService
required
boolean
tags
Array of strings
required
object
Array of objects
eanCode
null or string <= 13 characters
unitUuid
required
string <uuid>
cost
required
number
taxRate
null or number
bookingAccountNumber
null or string

Responses

Request samples

Content type
application/json
{
  • "productKey": "P0123-456",
  • "productGroupNumber": "44",
  • "isService": true,
  • "tags": [
    ],
  • "translations": {
    },
  • "properties": [
    ],
  • "eanCode": "5234816352132",
  • "unitUuid": "4ea8f502-b003-41e6-a190-c2ae59ac4f26",
  • "cost": 72.5,
  • "taxRate": 7.7,
  • "bookingAccountNumber": 2540
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Remove an existing product

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the product should be created

productUuid
required
string <uuid>

UUID of the product to delete

Responses

Available actions for an existing product

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

productUuid
required
string <uuid>

UUID of the product

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Execute an action on an existing product

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the product should be created

productUuid
required
string <uuid>

UUID of the product

action
required
string

Action to do

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string"
}

ProductGroups

Manage Product Groups

Product groups List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

query Parameters
onlyArchived
boolean

Get only product groups which are archived or not

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create a new product group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the product should be created

Request Body schema: application/json
groupNumber
required
integer
bookingAccountNumber
required
null or string
required
object

Responses

Request samples

Content type
application/json
{
  • "groupNumber": 301,
  • "bookingAccountNumber": "1020",
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Check product group number

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

query Parameters
uuid
string <uuid>

Related to the exist product group

groupNumber
required
integer

Free group number to check

Responses

single product group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

groupUuid
required
string <uuid>

UUID of the product group

query Parameters
onlyArchived
boolean

Get only product group which are archived or not

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update product group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the product should be created

groupUuid
required
string <uuid>

UUID of the product group

Request Body schema: application/json
groupNumber
required
integer
bookingAccountNumber
required
null or string
required
object

Responses

Request samples

Content type
application/json
{
  • "groupNumber": 301,
  • "bookingAccountNumber": "1020",
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete product group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the product should be created

groupUuid
required
string <uuid>

UUID of the product group

Responses

Archive product group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the product should be created

groupUuid
required
string <uuid>

UUID of the product group

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Restore product group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the product should be created

groupUuid
required
string <uuid>

UUID of the product group

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Units

Manage Units

Units List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Create a new unit

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the unit should be created

Request Body schema: application/json
isocode
string or null <= 10 characters
active
required
boolean
required
object

Responses

Request samples

Content type
application/json
{
  • "isocode": "KGM",
  • "active": true,
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Single Unit

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

unitUuid
required
string <uuid>

UUID of the unit

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Single unit update

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

unitUuid
required
string <uuid>

UUID of the unit

Request Body schema: application/json
isocode
string or null <= 10 characters
active
required
boolean
required
object

Responses

Request samples

Content type
application/json
{
  • "isocode": "KGM",
  • "active": true,
  • "translations": {
    }
}

Delete unit

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the queue is located

unitUuid
required
string <uuid>

UUID of the unit

Responses

Employee

Manage Employee

Employee List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

query Parameters
onlyInactive
boolean

Can filter employees for active or inactive

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Request Body schema: application/json
employeeNumber
required
string <= 255 characters
firstName
required
string <= 255 characters
lastName
string or null <= 255 characters
userUuid
string or null <uuid>
employmentStartDate
required
string <date>
birthDate
string or null <date>
addressUuid
string or null <uuid>
employeeGroupUuid
required
string or null <uuid>
timeTrackingStartDate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "employeeNumber": "MA032",
  • "firstName": "Max",
  • "lastName": "Mustermann",
  • "userUuid": "4ce39d1b-3472-4fd4-b7b3-6de8686ea9fe",
  • "employmentStartDate": "2006-08-01",
  • "birthDate": "1977-05-18",
  • "addressUuid": "ee8b1375-263b-40eb-9968-a845b6e3badf",
  • "employeeGroupUuid": "1e48834f-8b76-40d3-9a18-1c09b630fd2e",
  • "timeTrackingStartDate": "2021-03-01"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "firstName": "string",
  • "lastName": "string",
  • "employeeNumber": "string",
  • "birthDate": "2023-03-28",
  • "employeeGroup": {
    },
  • "isActive": true,
  • "user": {
    },
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "addressUuid": "ac453eba-e855-4d33-9d8a-d578082d651a",
  • "timeTrackingStartDate": "2020-05-01",
  • "timeTrackingStartDateEditable": true,
  • "isPresent": true
}

Available Users

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

query Parameters
employeeUuid
string <uuid>

Filter with included employeeUuid

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Single employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "firstName": "string",
  • "lastName": "string",
  • "employeeNumber": "string",
  • "birthDate": "2023-03-28",
  • "employeeGroup": {
    },
  • "isActive": true,
  • "user": {
    },
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "addressUuid": "ac453eba-e855-4d33-9d8a-d578082d651a",
  • "timeTrackingStartDate": "2020-05-01",
  • "timeTrackingStartDateEditable": true,
  • "isPresent": true
}

Update employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Request Body schema: application/json
employeeNumber
required
string <= 255 characters
firstName
required
string <= 255 characters
lastName
string or null <= 255 characters
userUuid
string or null <uuid>
employmentStartDate
required
string <date>
birthDate
string or null <date>
addressUuid
string or null <uuid>
employeeGroupUuid
required
string or null <uuid>
timeTrackingStartDate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "employeeNumber": "MA032",
  • "firstName": "Max",
  • "lastName": "Mustermann",
  • "userUuid": "4ce39d1b-3472-4fd4-b7b3-6de8686ea9fe",
  • "employmentStartDate": "2006-08-01",
  • "birthDate": "1977-05-18",
  • "addressUuid": "ee8b1375-263b-40eb-9968-a845b6e3badf",
  • "employeeGroupUuid": "1e48834f-8b76-40d3-9a18-1c09b630fd2e",
  • "timeTrackingStartDate": "2021-03-01"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "firstName": "string",
  • "lastName": "string",
  • "employeeNumber": "string",
  • "birthDate": "2023-03-28",
  • "employeeGroup": {
    },
  • "isActive": true,
  • "user": {
    },
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "addressUuid": "ac453eba-e855-4d33-9d8a-d578082d651a",
  • "timeTrackingStartDate": "2020-05-01",
  • "timeTrackingStartDateEditable": true,
  • "isPresent": true
}

Remove employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Responses

EmployeeGroups

Manage Employee Groups

List employee groups

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create employee group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "description": "string",
  • "name": "string",
  • "translations": {
    }
}

Single employee group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeGroupUuid
required
string <uuid>

UUID of AbaNinja Employee group

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "description": "string",
  • "name": "string",
  • "translations": {
    }
}

Update employee group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeGroupUuid
required
string <uuid>

UUID of AbaNinja Employee group

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "description": "string",
  • "name": "string",
  • "translations": {
    }
}

Remove employee group

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeGroupUuid
required
string <uuid>

UUID of AbaNinja Employee group

Responses

EmployeeInOut

Manage Employee Timestamps (In&Out)

Create In&Out Entry

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Request Body schema: application/json
date
required
string <date>
startTime
required
string
endTime
string or null
comment
string or null
device
string or null

Responses

Request samples

Content type
application/json
{
  • "date": "2020-04-14",
  • "startTime": "14:23",
  • "endTime": "16:55",
  • "comment": "Nothing special"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "date": "2020-05-04",
  • "startTime": "14:45",
  • "endTime": "16:25",
  • "startDevice": "string",
  • "endDevice": "string",
  • "type": "string",
  • "comment": "string",
  • "isClosed": true,
  • "closedAt": "2021-03-07 13:33:51",
  • "duration": {
    }
}

List not closed In&Out entries

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

query Parameters
date
string

Date to search until. Otherwise until yesterday

Responses

Response samples

Content type
application/json
[
  • "2019-08-24"
]

Single In&Out entry

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

inOutUuid
required
string <uuid>

UUID of AbaNinja Employee In&Out Item

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "date": "2020-05-04",
  • "startTime": "14:45",
  • "endTime": "16:25",
  • "startDevice": "string",
  • "endDevice": "string",
  • "type": "string",
  • "comment": "string",
  • "isClosed": true,
  • "closedAt": "2021-03-07 13:33:51",
  • "duration": {
    }
}

Update In&Out entry

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

inOutUuid
required
string <uuid>

UUID of AbaNinja Employee In&Out Item

Request Body schema: application/json
date
required
string <date>
startTime
required
string
endTime
string or null
comment
string or null
device
string or null

Responses

Request samples

Content type
application/json
{
  • "date": "2020-04-14",
  • "startTime": "14:23",
  • "endTime": "16:55",
  • "comment": "Nothing special"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "date": "2020-05-04",
  • "startTime": "14:45",
  • "endTime": "16:25",
  • "startDevice": "string",
  • "endDevice": "string",
  • "type": "string",
  • "comment": "string",
  • "isClosed": true,
  • "closedAt": "2021-03-07 13:33:51",
  • "duration": {
    }
}

Remove In&Out entry

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

inOutUuid
required
string <uuid>

UUID of AbaNinja Employee In&Out Item

Responses

EmployeeActivities

Manage Employee Activities

Create activity

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Request Body schema: application/json
activityTypeUuid
required
string <uuid>
startDate
required
string <date>
endDate
required
string <date>
startTime
required
string^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$
endTime
required
string^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$
halfDay
required
boolean
addressUuid
string or null <uuid>
contractNoteUuid
string or null <uuid>
productUuid
string or null <uuid>
description
string or null

Responses

Request samples

Content type
application/json
{
  • "activityTypeUuid": "9af38632-5ed7-4dc9-b48c-ec0c57416649",
  • "startDate": "2022-03-07",
  • "endDate": "2022-03-07",
  • "startTime": "14:35",
  • "endTime": "15:45",
  • "halfDay": false,
  • "addressUuid": "c0a5b10b-7570-41ea-b33a-3f66ec54df44",
  • "contractNoteUuid": "57660e14-6958-4661-a70d-921629a4cc48",
  • "productUuid": "23a38d60-fddc-44b3-af53-9cc0e4319e38",
  • "description": "I did something for the customer"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "employeeUuid": "6e11f5ee-ef7d-45b1-b867-e1f88b1af300",
  • "activityTypeUuid": "6fd8900e-111f-47d3-8cca-39f36e13da65",
  • "addressUuid": "ac453eba-e855-4d33-9d8a-d578082d651a",
  • "addressDescription": "string",
  • "productUuid": "3a88375a-5ea7-4e22-b7fe-b3c10f9367f3",
  • "productKey": "string",
  • "productDescription": "string",
  • "startDate": "2022-05-16",
  • "endDate": "2022-05-16",
  • "startTime": "18:30",
  • "endTime": "23:45",
  • "halfDay": true,
  • "description": "string",
  • "contractNoteId": 0,
  • "contractNoteUuid": "422b3f82-4941-4e84-8f32-264b19d079b4",
  • "isInvoiced": true,
  • "isClosed": true,
  • "closedAt": "2022-04-10",
  • "contractNoteName": "string",
  • "poNumber": "string"
}

Single employee activity

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

activityUuid
required
string <uuid>

UUID of AbaNinja Employee Activity Item

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "employeeUuid": "6e11f5ee-ef7d-45b1-b867-e1f88b1af300",
  • "activityTypeUuid": "6fd8900e-111f-47d3-8cca-39f36e13da65",
  • "addressUuid": "ac453eba-e855-4d33-9d8a-d578082d651a",
  • "addressDescription": "string",
  • "productUuid": "3a88375a-5ea7-4e22-b7fe-b3c10f9367f3",
  • "productKey": "string",
  • "productDescription": "string",
  • "startDate": "2022-05-16",
  • "endDate": "2022-05-16",
  • "startTime": "18:30",
  • "endTime": "23:45",
  • "halfDay": true,
  • "description": "string",
  • "contractNoteId": 0,
  • "contractNoteUuid": "422b3f82-4941-4e84-8f32-264b19d079b4",
  • "isInvoiced": true,
  • "isClosed": true,
  • "closedAt": "2022-04-10",
  • "contractNoteName": "string",
  • "poNumber": "string"
}

Update employee activity

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

activityUuid
required
string <uuid>

UUID of AbaNinja Employee Activity Item

Request Body schema: application/json
activityTypeUuid
required
string <uuid>
startDate
required
string <date>
endDate
required
string <date>
startTime
required
string^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$
endTime
required
string^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$
halfDay
required
boolean
addressUuid
string or null <uuid>
contractNoteUuid
string or null <uuid>
productUuid
string or null <uuid>
description
string or null

Responses

Request samples

Content type
application/json
{
  • "activityTypeUuid": "9af38632-5ed7-4dc9-b48c-ec0c57416649",
  • "startDate": "2022-03-07",
  • "endDate": "2022-03-07",
  • "startTime": "14:35",
  • "endTime": "15:45",
  • "halfDay": false,
  • "addressUuid": "c0a5b10b-7570-41ea-b33a-3f66ec54df44",
  • "contractNoteUuid": "57660e14-6958-4661-a70d-921629a4cc48",
  • "productUuid": "23a38d60-fddc-44b3-af53-9cc0e4319e38",
  • "description": "I did something for the customer"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "employeeUuid": "6e11f5ee-ef7d-45b1-b867-e1f88b1af300",
  • "activityTypeUuid": "6fd8900e-111f-47d3-8cca-39f36e13da65",
  • "addressUuid": "ac453eba-e855-4d33-9d8a-d578082d651a",
  • "addressDescription": "string",
  • "productUuid": "3a88375a-5ea7-4e22-b7fe-b3c10f9367f3",
  • "productKey": "string",
  • "productDescription": "string",
  • "startDate": "2022-05-16",
  • "endDate": "2022-05-16",
  • "startTime": "18:30",
  • "endTime": "23:45",
  • "halfDay": true,
  • "description": "string",
  • "contractNoteId": 0,
  • "contractNoteUuid": "422b3f82-4941-4e84-8f32-264b19d079b4",
  • "isInvoiced": true,
  • "isClosed": true,
  • "closedAt": "2022-04-10",
  • "contractNoteName": "string",
  • "poNumber": "string"
}

Remove employee activity

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

activityUuid
required
string <uuid>

UUID of AbaNinja Employee Activity Item

Responses

EmployeeTimeSettings

Manage Employee Contract, Time Corrections and Closures

List contracts from employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create contract for employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Request Body schema: application/json
monday
required
boolean
tuesday
required
boolean
wednesday
required
boolean
thursday
required
boolean
friday
required
boolean
saturday
required
boolean
sunday
required
boolean
validFromDate
required
string <date>
validToDate
string or null <date>
employeeWorkModelUuid
required
string <uuid>
employmentFactor
required
number or null
shortTimeWorkFactor
required
number
workingCountryCode
required
string
workingStateCode
required
string
hoursPerWeek
required
number
holidaysPerYear
required
number

Responses

Request samples

Content type
application/json
{
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": false,
  • "sunday": false,
  • "validFromDate": "2020-02-01",
  • "validToDate": null,
  • "employeeWorkModelUuid": "a0d52a2a-382b-4fcc-853f-24db1303fe3f",
  • "employmentFactor": 100,
  • "shortTimeWorkFactor": 0,
  • "workingCountryCode": "CH",
  • "workingState": "SG",
  • "hoursPerWeek": 42,
  • "holidaysPerYear": 25
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": true,
  • "sunday": true,
  • "validFromDate": "2018-04-01",
  • "validToDate": "2024-10-31",
  • "employeeWorkModelUuid": "ebd15507-ae4e-4e67-b3b8-ea8281569d4c",
  • "employeeAddOnWorkModelUuid": "a186332c-5b61-4065-9257-f183becfd0e3",
  • "employmentFactor": 0,
  • "shortTimeWorkFactor": 0,
  • "workingDays": 0,
  • "hoursPerWeek": 0,
  • "holidaysPerYear": 0,
  • "workingState": "SG",
  • "workingStateName": "Sankt Gallen",
  • "workingCountryCode": "CH",
  • "workingCountryName": "Swiss",
  • "isClosed": true
}

Allowed contract days

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

query Parameters
startDate
string

Year and month of possible start dates

endDate
string

Year and month of possible end dates

contractUuid
string <uuid>

UUID of exist contract to check

Responses

Response samples

Content type
application/json
{
  • "earliestDate": "2019-08-24",
  • "startDays": [
    ],
  • "endDays": [
    ]
}

Last contract

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": true,
  • "sunday": true,
  • "validFromDate": "2018-04-01",
  • "validToDate": "2024-10-31",
  • "employeeWorkModelUuid": "ebd15507-ae4e-4e67-b3b8-ea8281569d4c",
  • "employeeAddOnWorkModelUuid": "a186332c-5b61-4065-9257-f183becfd0e3",
  • "employmentFactor": 0,
  • "shortTimeWorkFactor": 0,
  • "workingDays": 0,
  • "hoursPerWeek": 0,
  • "holidaysPerYear": 0,
  • "workingState": "SG",
  • "workingStateName": "Sankt Gallen",
  • "workingCountryCode": "CH",
  • "workingCountryName": "Swiss",
  • "isClosed": true
}

Single contract from employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

contractUuid
required
string <uuid>

UUID of AbaNinja Employee Contract

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": true,
  • "sunday": true,
  • "validFromDate": "2018-04-01",
  • "validToDate": "2024-10-31",
  • "employeeWorkModelUuid": "ebd15507-ae4e-4e67-b3b8-ea8281569d4c",
  • "employeeAddOnWorkModelUuid": "a186332c-5b61-4065-9257-f183becfd0e3",
  • "employmentFactor": 0,
  • "shortTimeWorkFactor": 0,
  • "workingDays": 0,
  • "hoursPerWeek": 0,
  • "holidaysPerYear": 0,
  • "workingState": "SG",
  • "workingStateName": "Sankt Gallen",
  • "workingCountryCode": "CH",
  • "workingCountryName": "Swiss",
  • "isClosed": true
}

Update contract from employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

contractUuid
required
string <uuid>

UUID of AbaNinja Employee Contract

Request Body schema: application/json
monday
required
boolean
tuesday
required
boolean
wednesday
required
boolean
thursday
required
boolean
friday
required
boolean
saturday
required
boolean
sunday
required
boolean
validFromDate
required
string <date>
validToDate
string or null <date>
employeeWorkModelUuid
required
string <uuid>
employmentFactor
required
number or null
shortTimeWorkFactor
required
number
workingCountryCode
required
string
workingStateCode
required
string
hoursPerWeek
required
number
holidaysPerYear
required
number

Responses

Request samples

Content type
application/json
{
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": false,
  • "sunday": false,
  • "validFromDate": "2020-02-01",
  • "validToDate": null,
  • "employeeWorkModelUuid": "a0d52a2a-382b-4fcc-853f-24db1303fe3f",
  • "employmentFactor": 100,
  • "shortTimeWorkFactor": 0,
  • "workingCountryCode": "CH",
  • "workingState": "SG",
  • "hoursPerWeek": 42,
  • "holidaysPerYear": 25
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": true,
  • "sunday": true,
  • "validFromDate": "2018-04-01",
  • "validToDate": "2024-10-31",
  • "employeeWorkModelUuid": "ebd15507-ae4e-4e67-b3b8-ea8281569d4c",
  • "employeeAddOnWorkModelUuid": "a186332c-5b61-4065-9257-f183becfd0e3",
  • "employmentFactor": 0,
  • "shortTimeWorkFactor": 0,
  • "workingDays": 0,
  • "hoursPerWeek": 0,
  • "holidaysPerYear": 0,
  • "workingState": "SG",
  • "workingStateName": "Sankt Gallen",
  • "workingCountryCode": "CH",
  • "workingCountryName": "Swiss",
  • "isClosed": true
}

Remove contract from employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

contractUuid
required
string <uuid>

UUID of AbaNinja Employee Contract

Responses

List time corrections for employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create time correction for employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Request Body schema: application/json
type
required
integer
Enum: 1 2

1 = Timecorrection, 2 = Holidaycorrection

bookingDate
required
string <date>
bookingQty
required
number
bookingUnit
required
string
Enum: "hrs" "day"
bookingText
string or null

Responses

Request samples

Content type
application/json
{
  • "type": 1,
  • "bookingDate": "2006-08-01",
  • "bookingQty": 3.5,
  • "bookingUnit": "hrs",
  • "bookingText": "A special present"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "employeeUuid": "6e11f5ee-ef7d-45b1-b867-e1f88b1af300",
  • "type": 0,
  • "isClosed": true,
  • "bookingDate": "2019-08-24",
  • "bookingQty": 0,
  • "bookingUnit": "hrs",
  • "bookingText": "string"
}

Single time correction from employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

correctionUuid
required
string <uuid>

UUID of AbaNinja Employee Contract

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "employeeUuid": "6e11f5ee-ef7d-45b1-b867-e1f88b1af300",
  • "type": 0,
  • "isClosed": true,
  • "bookingDate": "2019-08-24",
  • "bookingQty": 0,
  • "bookingUnit": "hrs",
  • "bookingText": "string"
}

Update time correction from employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

correctionUuid
required
string <uuid>

UUID of AbaNinja Employee Contract

Request Body schema: application/json
type
required
integer
Enum: 1 2

1 = Timecorrection, 2 = Holidaycorrection

bookingDate
required
string <date>
bookingQty
required
number
bookingUnit
required
string
Enum: "hrs" "day"
bookingText
string or null

Responses

Request samples

Content type
application/json
{
  • "type": 1,
  • "bookingDate": "2006-08-01",
  • "bookingQty": 3.5,
  • "bookingUnit": "hrs",
  • "bookingText": "A special present"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "employeeUuid": "6e11f5ee-ef7d-45b1-b867-e1f88b1af300",
  • "type": 0,
  • "isClosed": true,
  • "bookingDate": "2019-08-24",
  • "bookingQty": 0,
  • "bookingUnit": "hrs",
  • "bookingText": "string"
}

Remove time correction from employee

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

correctionUuid
required
string <uuid>

UUID of AbaNinja Employee Contract

Responses

List of closures

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create closure

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Request Body schema: application/json
closureDate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "closureDate": "2006-05-31"
}

Last closure

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

Responses

Response samples

Content type
application/json
{
  • "timeTrackingStart": "2019-08-24",
  • "lastClosureDate": "2019-08-24"
}

Remove closure

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

closureUuid
required
string <uuid>

UUID of AbaNinja Employee Closure

Responses

EmployeeStatistics

Get Statistic (Today)

Employee holiday

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

query Parameters
date
string <date>

Date

Responses

Response samples

Content type
application/json
{
  • "unitName": "string",
  • "transferDays": 0,
  • "plannedDays": 0,
  • "contractDays": 0,
  • "usedDays": 0,
  • "balanceDays": 0,
  • "balanceEndDate": "string",
  • "correctionDays": 0
}

Employee flex time

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

query Parameters
date
string <date>

Date

Responses

Response samples

Content type
application/json
{
  • "flexTime": "85.55h",
  • "flexTimeRaw": 85.55
}

Employee target time

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

query Parameters
date
string <date>

Date

Responses

Response samples

Content type
application/json
{
  • "contractTypeName": "string",
  • "employmentFactor": 0,
  • "hoursPerWeek": 0,
  • "employeeWorkModelName": "string",
  • "shortWorkPercent": 0
}

Employee calendar

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

query Parameters
dateFrom
string <date>
dateTo
string <date>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employee daily

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

date
required
string <date>

Date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List not closed In&Out entries

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

date
required
string <date>

Date

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "startTime": "14:38",
  • "notes": "string"
}

Daily Closed

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

date
required
string <date>

Date

Responses

Response samples

Content type
application/json
{
  • "isClosed": true
}

Employee Daily totals

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

employeeUuid
required
string <uuid>

UUID of AbaNinja Employee

date
required
string <date>

Date

Responses

Response samples

Content type
application/json
{
  • "targetTime": {
    },
  • "targetTimeDifference": {
    },
  • "sectionTotal": {
    },
  • "flexTime": {
    }
}

SettingsTime

Manage Time Settings

List holiday for state

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

query Parameters
year
integer or null
date
string or null
Example: date=2020-05-17
countryCode
required
string
state
string or null [ 2 .. 6 ] characters
type
integer or null

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create holiday entry

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Request Body schema: application/json
date
required
string <date>
countryCode
required
string
state
required
string
halfDay
required
boolean
required
object

Responses

Request samples

Content type
application/json
{
  • "date": "2023-07-13",
  • "countryCode": "CH",
  • "state": "AG",
  • "halfDay": false,
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "date": "2020-04-18",
  • "halfDay": true,
  • "countryCode": "CH",
  • "state": "SG",
  • "name": "string",
  • "translations": {
    }
}

Single holiday

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

holidayUuid
required
string <uuid>

UUID of holiday entry

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "date": "2020-04-18",
  • "halfDay": true,
  • "countryCode": "CH",
  • "state": "SG",
  • "name": "string",
  • "translations": {
    }
}

Update holiday

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

holidayUuid
required
string <uuid>

UUID of holiday entry

Request Body schema: application/json
date
required
string <date>
countryCode
required
string
state
required
string
halfDay
required
boolean
required
object

Responses

Request samples

Content type
application/json
{
  • "date": "2023-07-13",
  • "countryCode": "CH",
  • "state": "AG",
  • "halfDay": false,
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "date": "2020-04-18",
  • "halfDay": true,
  • "countryCode": "CH",
  • "state": "SG",
  • "name": "string",
  • "translations": {
    }
}

Remove holiday

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

holidayUuid
required
string <uuid>

UUID of holiday entry

Responses

List of activity types

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create activity type

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Request Body schema: application/json
activityNumber
required
string
unit
required
string
isCount
required
boolean
isBillable
required
boolean
isHoliday
required
boolean
activityGroup
required
integer
isTimeCredit
required
boolean
isShortTimeWork
required
boolean
isFavorite
boolean
required
object

Responses

Request samples

Content type
application/json
{
  • "activityNumber": "AC502",
  • "unit": "HUR",
  • "isCount": true,
  • "isBillable": false,
  • "isHoliday": false,
  • "activityGroup": 1,
  • "isTimeCredit": true,
  • "isShortTimeWork": false,
  • "isFavorite": true,
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "activityTypeMasterUuid": "d66fba5a-f7df-4be1-97d0-d528c4db72db",
  • "activityNumber": "string",
  • "unit": "string",
  • "isCount": true,
  • "isBillable": true,
  • "isHoliday": true,
  • "activityGroup": 1,
  • "isTimecredit": true,
  • "isShortTimeWork": true,
  • "isFavorite": true,
  • "used": true,
  • "description": "string",
  • "translations": {
    }
}

Single activity type

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

activityTypeUuid
required
string <uuid>

UUID of Activity Type

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "activityTypeMasterUuid": "d66fba5a-f7df-4be1-97d0-d528c4db72db",
  • "activityNumber": "string",
  • "unit": "string",
  • "isCount": true,
  • "isBillable": true,
  • "isHoliday": true,
  • "activityGroup": 1,
  • "isTimecredit": true,
  • "isShortTimeWork": true,
  • "isFavorite": true,
  • "used": true,
  • "description": "string",
  • "translations": {
    }
}

Update activity type

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

activityTypeUuid
required
string <uuid>

UUID of Activity Type

Request Body schema: application/json
activityNumber
required
string
unit
required
string
isCount
required
boolean
isBillable
required
boolean
isHoliday
required
boolean
activityGroup
required
integer
isTimeCredit
required
boolean
isShortTimeWork
required
boolean
isFavorite
boolean
required
object

Responses

Request samples

Content type
application/json
{
  • "activityNumber": "AC502",
  • "unit": "HUR",
  • "isCount": true,
  • "isBillable": false,
  • "isHoliday": false,
  • "activityGroup": 1,
  • "isTimeCredit": true,
  • "isShortTimeWork": false,
  • "isFavorite": true,
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "activityTypeMasterUuid": "d66fba5a-f7df-4be1-97d0-d528c4db72db",
  • "activityNumber": "string",
  • "unit": "string",
  • "isCount": true,
  • "isBillable": true,
  • "isHoliday": true,
  • "activityGroup": 1,
  • "isTimecredit": true,
  • "isShortTimeWork": true,
  • "isFavorite": true,
  • "used": true,
  • "description": "string",
  • "translations": {
    }
}

Remove activity type

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

activityTypeUuid
required
string <uuid>

UUID of Activity Type

Responses

List work models

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create work model

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Request Body schema: application/json
hoursPerWeek
required
number
holidaysPerYear
required
number
monday
required
boolean
tuesday
required
boolean
wednesday
required
boolean
thursday
required
boolean
friday
required
boolean
saturday
required
boolean
sunday
required
boolean
required
object

Responses

Request samples

Content type
application/json
{
  • "hoursPerWeek": 42,
  • "holidaysPerYear": 25,
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": false,
  • "sunday": false,
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "hoursPerWeek": 0,
  • "holidaysPerYear": 0,
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": true,
  • "sunday": true,
  • "isUsed": true,
  • "isSystem": true,
  • "description": "string",
  • "name": "string",
  • "translations": {
    }
}

Single work model

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

workModelUuid
required
string <uuid>

UUID of Work Model

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "hoursPerWeek": 0,
  • "holidaysPerYear": 0,
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": true,
  • "sunday": true,
  • "isUsed": true,
  • "isSystem": true,
  • "description": "string",
  • "name": "string",
  • "translations": {
    }
}

Update work model

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

workModelUuid
required
string <uuid>

UUID of Work Model

Request Body schema: application/json
hoursPerWeek
required
number
holidaysPerYear
required
number
monday
required
boolean
tuesday
required
boolean
wednesday
required
boolean
thursday
required
boolean
friday
required
boolean
saturday
required
boolean
sunday
required
boolean
required
object

Responses

Request samples

Content type
application/json
{
  • "hoursPerWeek": 42,
  • "holidaysPerYear": 25,
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": false,
  • "sunday": false,
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "hoursPerWeek": 0,
  • "holidaysPerYear": 0,
  • "monday": true,
  • "tuesday": true,
  • "wednesday": true,
  • "thursday": true,
  • "friday": true,
  • "saturday": true,
  • "sunday": true,
  • "isUsed": true,
  • "isSystem": true,
  • "description": "string",
  • "name": "string",
  • "translations": {
    }
}

Remove work model

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

workModelUuid
required
string <uuid>

UUID of Work Model

Responses

Activity settings

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Responses

Response samples

Content type
application/json
{
  • "translations": {
    }
}

Update activity settings

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "translations": {
    }
}

Holiday settings

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Responses

Response samples

Content type
application/json
{
  • "useSystemHolidays": true
}

Update holiday settings

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Request Body schema: application/json
useSystemHolidays
required
boolean

Responses

Request samples

Content type
application/json
{
  • "useSystemHolidays": true
}

Response samples

Content type
application/json
{
  • "useSystemHolidays": true
}

Convert holiday

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of AbaNinja Account

Request Body schema: application/json
year
required
integer
countryCode
required
string
state
required
string

Responses

Request samples

Content type
application/json
{
  • "year": 2023,
  • "countryCode": "CH",
  • "state": "AG"
}