API docs by Redocly

Kleer API (v1)

Download OpenAPI specification:

Kleer API

This is the aggregated documentation for Kleer's public REST APIs. Each sub-API is owned and operated by its own service, but is exposed here under a shared host and a shared version so the whole API surface can be explored in one place.

Environments

Environment Base URL
Test https://api.test.kleer.se

All resources live under the version prefix /v1.

Authentication

The API is protected by OAuth2 tokens issued by Kleer's Keycloak. Send a valid access token in the Authorization header on every request:

Authorization: Bearer <access_token>

Requests without a valid token are rejected at the edge before reaching any service.

How the documentation is organized

The navigation on the left is grouped per sub-API, in a logical order — from identity and master data (users, companies, clients) through projects and purchasing to revenue, banking, payroll and accounting. Schema names are prefixed with their respective sub-API's name so that similarly named models from different services are not conflated.

user

Get users

Returns company users. When foreignId is supplied, returns the user collection (zero or one) matching that foreign ID.

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
offset
integer <int32> >= 0
Default: 0

The first result offset. Defaults to 0.

limit
integer <int32> [ 1 .. 100 ]
Default: 100

The maximum number of users to return. Defaults to 100.

createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

foreignId
string

When supplied, filters the collection to the user matching this external/foreign identifier.

Responses

Response samples

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

Create user

Creates a company user.

path Parameters
companyId
required
string <uuid>

The company UUID.

Request Body schema: application/json
required
foreignId
string
name
required
string
email
required
string <email>
active
required
boolean
object (User_REST_API_DimensionsDistribution)
dimensionUserPercentage
number

Responses

Request samples

Content type
application/json
{
  • "foreignId": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "active": true,
  • "dimensions": {
    },
  • "dimensionUserPercentage": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "active": true,
  • "dimensionEntry": {
    },
  • "dimensions": {
    },
  • "dimensionUserPercentage": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get current user

Returns the current authenticated user.

path Parameters
companyId
required
string <uuid>

The company UUID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "active": true,
  • "dimensionEntry": {
    },
  • "dimensions": {
    },
  • "dimensionUserPercentage": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get company roles

Returns available company access roles.

path Parameters
companyId
required
string <uuid>

The company UUID.

Responses

Response samples

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

Get accesses for user

Returns access mappings for a user.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

Responses

Response samples

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

Create access for user

Adds a legacy access mapping for a user.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

type
required
string (User_REST_API_AccessType)
Enum: "Auditor" "Administrator" "AdministratorWithPayroll" "ClientAgreementOwn" "ClientInvoice" "ClientInvoiceRead" "ClientInvoiceCreate" "ClientInvoiceCertifyOwn" "ClientInvoiceOwn" "ClientInvoicePay" "ClientProjectOwn" "CustomerManagerSeb" "DimensionOwn" "Dimensions" "Expenses" "ExpensesOwn" "ExpensesPay" "Expert" "ExternalAccountant" "Manager" "Payroll" "PayrollRead" "PayrollOwn" "PayrollPay" "Remuneration" "RemunerationOwn" "Responsible" "ResponsibleRead" "SupplierInvoice" "SupplierInvoiceRead" "SupplierInvoiceSecretRead" "SupplierInvoiceCertifyOrg" "SupplierInvoiceCreate" "SupplierInvoicePay" "Timereport" "TimereportOwn" "Subcontractor" "PayrollSecret" "PayrollSecretRead" "FoundationGrantPay" "FoundationGrant" "AttachmentRequest" "InternalTransferPay"

The legacy access type.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Delete access for user

Removes a legacy access mapping for a user.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

type
required
string (User_REST_API_AccessType)
Enum: "Auditor" "Administrator" "AdministratorWithPayroll" "ClientAgreementOwn" "ClientInvoice" "ClientInvoiceRead" "ClientInvoiceCreate" "ClientInvoiceCertifyOwn" "ClientInvoiceOwn" "ClientInvoicePay" "ClientProjectOwn" "CustomerManagerSeb" "DimensionOwn" "Dimensions" "Expenses" "ExpensesOwn" "ExpensesPay" "Expert" "ExternalAccountant" "Manager" "Payroll" "PayrollRead" "PayrollOwn" "PayrollPay" "Remuneration" "RemunerationOwn" "Responsible" "ResponsibleRead" "SupplierInvoice" "SupplierInvoiceRead" "SupplierInvoiceSecretRead" "SupplierInvoiceCertifyOrg" "SupplierInvoiceCreate" "SupplierInvoicePay" "Timereport" "TimereportOwn" "Subcontractor" "PayrollSecret" "PayrollSecretRead" "FoundationGrantPay" "FoundationGrant" "AttachmentRequest" "InternalTransferPay"

The legacy access type.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get user

Returns a single user.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "active": true,
  • "dimensionEntry": {
    },
  • "dimensions": {
    },
  • "dimensionUserPercentage": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update user

Updates a user in the company context.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

Request Body schema: application/json
required
foreignId
string
name
required
string
email
required
string <email>
active
required
boolean
object (User_REST_API_DimensionsDistribution)
dimensionUserPercentage
number

Responses

Request samples

Content type
application/json
{
  • "foreignId": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "active": true,
  • "dimensions": {
    },
  • "dimensionUserPercentage": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "active": true,
  • "dimensionEntry": {
    },
  • "dimensions": {
    },
  • "dimensionUserPercentage": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get user roles

Returns roles for a specific user.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

Responses

Response samples

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

Remove all user roles

Removes all roles for a specific user.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Add user role

Adds a role to a specific user.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

roleKey
required
string <uuid>

The role key.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Remove user role

Removes a role from a specific user.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

roleKey
required
string <uuid>

The role key.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Delete all accesses for user

Removes all legacy access mappings for a specific user.

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

The user ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

company

List the authenticated caller's accessible companies

query Parameters
cursor
string <uuid>

Page token from a previous response's pagination.nextCursor. Omit for the first page.

limit
integer <int32> [ 1 .. 1000 ]

Page size (default 100, maximum 1000). Values above 1000 are capped.

Responses

Response samples

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

Get company information

path Parameters
companyId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "orgno": "string",
  • "accountingCurrency": "string",
  • "bankgiro": 0,
  • "supplierInvoiceEmail": "string"
}

Send a message with optional file attachments for a company

path Parameters
companyId
required
string <uuid>
Request Body schema: application/json
required
subject
required
string
message
required
string
required
Array of objects (Company_REST_API_CompanyMessageFile)

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "message": "string",
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}

Import companies from an Excel file

path Parameters
companyId
required
string <uuid>
Request Body schema: application/json
required
data
required
string <byte>

Responses

Request samples

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

Response samples

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

other

Get clients

active and foreignId refine this list query and may be combined with each other and with pagination/timestamp filters. When foreignId is set the free-text query parameter is ignored; limit still applies to the foreign-id matches.

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
query
string
foreignId
string

Restrict the result to entities with this foreign ID. How it combines with the other parameters is endpoint-specific — see the operation description.

active
boolean

When true, restrict the result to active entities only.

cursor
string <uuid>

Page token from a previous response's pagination.nextCursor. Omit for the first page.

limit
integer <int32> >= 0
createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

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

Create client

path Parameters
companyId
required
string <uuid>

The company UUID.

Request Body schema: application/json
required
id
string <uuid>

Stable public identifier (ClientPublicId).

foreignId
string
name
string
contact
string
object (Client_REST_API_Address)
email
string
countryCode
string
currencyType
string
notes
string
paymentDays
integer <int32>
orgno
string
phone
string
object (Client_REST_API_UserReferenceUuid)
object (Client_REST_API_UserReferenceUuid)
deliveryType
string
vatNr
string
gln
string
object (Client_REST_API_ClientInvoiceTemplateReferenceUuid)
object (Client_REST_API_EdiRecipient)
fetchEdiRecipient
boolean
active
boolean
clientType
string
object (Client_REST_API_DimensionEntriesUuid)
object (Client_REST_API_ClientBrokerReferences)
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "contact": "string",
  • "address": {
    },
  • "email": "string",
  • "countryCode": "string",
  • "currencyType": "string",
  • "notes": "string",
  • "paymentDays": 0,
  • "orgno": "string",
  • "phone": "string",
  • "user": {
    },
  • "approver": {
    },
  • "deliveryType": "string",
  • "vatNr": "string",
  • "gln": "string",
  • "template": {
    },
  • "ediRecipient": {
    },
  • "fetchEdiRecipient": true,
  • "active": true,
  • "clientType": "string",
  • "dimensionEntries": {
    },
  • "clientBroker": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "contact": "string",
  • "address": {
    },
  • "email": "string",
  • "countryCode": "string",
  • "currencyType": "string",
  • "notes": "string",
  • "paymentDays": 0,
  • "orgno": "string",
  • "phone": "string",
  • "user": {
    },
  • "approver": {
    },
  • "deliveryType": "string",
  • "vatNr": "string",
  • "gln": "string",
  • "template": {
    },
  • "ediRecipient": {
    },
  • "fetchEdiRecipient": true,
  • "active": true,
  • "clientType": "string",
  • "dimensionEntries": {
    },
  • "clientBroker": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get client delivery types

path Parameters
companyId
required
string <uuid>

The company UUID.

Responses

Response samples

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

Get client by ID

path Parameters
companyId
required
string <uuid>

The company UUID.

clientId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "contact": "string",
  • "address": {
    },
  • "email": "string",
  • "countryCode": "string",
  • "currencyType": "string",
  • "notes": "string",
  • "paymentDays": 0,
  • "orgno": "string",
  • "phone": "string",
  • "user": {
    },
  • "approver": {
    },
  • "deliveryType": "string",
  • "vatNr": "string",
  • "gln": "string",
  • "template": {
    },
  • "ediRecipient": {
    },
  • "fetchEdiRecipient": true,
  • "active": true,
  • "clientType": "string",
  • "dimensionEntries": {
    },
  • "clientBroker": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update client

path Parameters
companyId
required
string <uuid>

The company UUID.

clientId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>

Stable public identifier (ClientPublicId).

foreignId
string
name
string
contact
string
object (Client_REST_API_Address)
email
string
countryCode
string
currencyType
string
notes
string
paymentDays
integer <int32>
orgno
string
phone
string
object (Client_REST_API_UserReferenceUuid)
object (Client_REST_API_UserReferenceUuid)
deliveryType
string
vatNr
string
gln
string
object (Client_REST_API_ClientInvoiceTemplateReferenceUuid)
object (Client_REST_API_EdiRecipient)
fetchEdiRecipient
boolean
active
boolean
clientType
string
object (Client_REST_API_DimensionEntriesUuid)
object (Client_REST_API_ClientBrokerReferences)
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "contact": "string",
  • "address": {
    },
  • "email": "string",
  • "countryCode": "string",
  • "currencyType": "string",
  • "notes": "string",
  • "paymentDays": 0,
  • "orgno": "string",
  • "phone": "string",
  • "user": {
    },
  • "approver": {
    },
  • "deliveryType": "string",
  • "vatNr": "string",
  • "gln": "string",
  • "template": {
    },
  • "ediRecipient": {
    },
  • "fetchEdiRecipient": true,
  • "active": true,
  • "clientType": "string",
  • "dimensionEntries": {
    },
  • "clientBroker": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "contact": "string",
  • "address": {
    },
  • "email": "string",
  • "countryCode": "string",
  • "currencyType": "string",
  • "notes": "string",
  • "paymentDays": 0,
  • "orgno": "string",
  • "phone": "string",
  • "user": {
    },
  • "approver": {
    },
  • "deliveryType": "string",
  • "vatNr": "string",
  • "gln": "string",
  • "template": {
    },
  • "ediRecipient": {
    },
  • "fetchEdiRecipient": true,
  • "active": true,
  • "clientType": "string",
  • "dimensionEntries": {
    },
  • "clientBroker": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get the latest revision of all client agreements

clientId and foreignId are agreement lookups (they may be combined with each other to narrow a client's agreements by foreign id) but cannot be combined with offset/limit or the createdAfter/createdBefore/updatedAfter/updatedBefore range filters, which apply only to the unfiltered list. Conflicting combinations are rejected with 400.

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
clientId
string <uuid>
foreignId
string

Restrict the result to entities with this foreign ID. How it combines with the other parameters is endpoint-specific — see the operation description.

offset
integer <int32> >= 0
limit
integer <int32> >= 0
createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

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

Create client agreement

path Parameters
companyId
required
string <uuid>

The company UUID.

Request Body schema: application/json
required
id
integer <int32>
foreignId
string
notes
string
revisionNr
integer <int32>
startDate
string
startInvoiceDate
string
nextInvoiceDate
string
endDate
string
renewalNotificationDate
string
yourReference
string
object (Client_REST_API_UserReference)
object (Client_REST_API_UserReference)
currency
string
paymentDays
integer <int32>
invoiceDay
string
invoiceIntervalMonths
integer <int32>
object (Client_REST_API_ClientInvoiceTemplateReference)
description
string
poNr
string
agreementNr
string
subscriptionNr
string
object (Client_REST_API_UserReference)
registrationDate
string
deleted
boolean
object (Client_REST_API_ClientReference)
object (Client_REST_API_ClientAgreementRows)
object (Client_REST_API_ClientAgreementRows)
object (Client_REST_API_Fields)
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "notes": "string",
  • "revisionNr": 0,
  • "startDate": "string",
  • "startInvoiceDate": "string",
  • "nextInvoiceDate": "string",
  • "endDate": "string",
  • "renewalNotificationDate": "string",
  • "yourReference": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "currency": "string",
  • "paymentDays": 0,
  • "invoiceDay": "string",
  • "invoiceIntervalMonths": 0,
  • "clientInvoiceTemplateRef": {
    },
  • "description": "string",
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "registrationUser": {
    },
  • "registrationDate": "string",
  • "deleted": true,
  • "clientRef": {
    },
  • "firstInvoiceRows": {
    },
  • "recurringRows": {
    },
  • "fields": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "notes": "string",
  • "revisionNr": 0,
  • "startDate": "string",
  • "startInvoiceDate": "string",
  • "nextInvoiceDate": "string",
  • "endDate": "string",
  • "renewalNotificationDate": "string",
  • "yourReference": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "currency": "string",
  • "paymentDays": 0,
  • "invoiceDay": "string",
  • "invoiceIntervalMonths": 0,
  • "clientInvoiceTemplateRef": {
    },
  • "description": "string",
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "registrationUser": {
    },
  • "registrationDate": "string",
  • "deleted": true,
  • "clientRef": {
    },
  • "firstInvoiceRows": {
    },
  • "recurringRows": {
    },
  • "fields": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete client agreement

path Parameters
companyId
required
string <uuid>

The company UUID.

agreementId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Get all revisions of a client agreement by ID

path Parameters
companyId
required
string <uuid>

The company UUID.

agreementId
required
integer <int32>

Responses

Response samples

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

Create a new revision of a client agreement

path Parameters
companyId
required
string <uuid>

The company UUID.

agreementId
required
integer <int32>
Request Body schema: application/json
required
id
integer <int32>
foreignId
string
notes
string
revisionNr
integer <int32>
startDate
string
startInvoiceDate
string
nextInvoiceDate
string
endDate
string
renewalNotificationDate
string
yourReference
string
object (Client_REST_API_UserReference)
object (Client_REST_API_UserReference)
currency
string
paymentDays
integer <int32>
invoiceDay
string
invoiceIntervalMonths
integer <int32>
object (Client_REST_API_ClientInvoiceTemplateReference)
description
string
poNr
string
agreementNr
string
subscriptionNr
string
object (Client_REST_API_UserReference)
registrationDate
string
deleted
boolean
object (Client_REST_API_ClientReference)
object (Client_REST_API_ClientAgreementRows)
object (Client_REST_API_ClientAgreementRows)
object (Client_REST_API_Fields)
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "notes": "string",
  • "revisionNr": 0,
  • "startDate": "string",
  • "startInvoiceDate": "string",
  • "nextInvoiceDate": "string",
  • "endDate": "string",
  • "renewalNotificationDate": "string",
  • "yourReference": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "currency": "string",
  • "paymentDays": 0,
  • "invoiceDay": "string",
  • "invoiceIntervalMonths": 0,
  • "clientInvoiceTemplateRef": {
    },
  • "description": "string",
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "registrationUser": {
    },
  • "registrationDate": "string",
  • "deleted": true,
  • "clientRef": {
    },
  • "firstInvoiceRows": {
    },
  • "recurringRows": {
    },
  • "fields": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "notes": "string",
  • "revisionNr": 0,
  • "startDate": "string",
  • "startInvoiceDate": "string",
  • "nextInvoiceDate": "string",
  • "endDate": "string",
  • "renewalNotificationDate": "string",
  • "yourReference": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "currency": "string",
  • "paymentDays": 0,
  • "invoiceDay": "string",
  • "invoiceIntervalMonths": 0,
  • "clientInvoiceTemplateRef": {
    },
  • "description": "string",
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "registrationUser": {
    },
  • "registrationDate": "string",
  • "deleted": true,
  • "clientRef": {
    },
  • "firstInvoiceRows": {
    },
  • "recurringRows": {
    },
  • "fields": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get a client agreement by revision number

path Parameters
companyId
required
string <uuid>

The company UUID.

agreementId
required
integer <int32>
revisionNr
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "notes": "string",
  • "revisionNr": 0,
  • "startDate": "string",
  • "startInvoiceDate": "string",
  • "nextInvoiceDate": "string",
  • "endDate": "string",
  • "renewalNotificationDate": "string",
  • "yourReference": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "currency": "string",
  • "paymentDays": 0,
  • "invoiceDay": "string",
  • "invoiceIntervalMonths": 0,
  • "clientInvoiceTemplateRef": {
    },
  • "description": "string",
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "registrationUser": {
    },
  • "registrationDate": "string",
  • "deleted": true,
  • "clientRef": {
    },
  • "firstInvoiceRows": {
    },
  • "recurringRows": {
    },
  • "fields": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get the latest revision of a client agreement by ID

path Parameters
companyId
required
string <uuid>

The company UUID.

agreementId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "notes": "string",
  • "revisionNr": 0,
  • "startDate": "string",
  • "startInvoiceDate": "string",
  • "nextInvoiceDate": "string",
  • "endDate": "string",
  • "renewalNotificationDate": "string",
  • "yourReference": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "currency": "string",
  • "paymentDays": 0,
  • "invoiceDay": "string",
  • "invoiceIntervalMonths": 0,
  • "clientInvoiceTemplateRef": {
    },
  • "description": "string",
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "registrationUser": {
    },
  • "registrationDate": "string",
  • "deleted": true,
  • "clientRef": {
    },
  • "firstInvoiceRows": {
    },
  • "recurringRows": {
    },
  • "fields": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get client invoice templates

When foreignId is supplied, returns only the templates with that foreign ID; otherwise returns all templates. No other filters apply to this endpoint.

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
foreignId
string

Restrict the result to entities with this foreign ID. How it combines with the other parameters is endpoint-specific — see the operation description.

Responses

Response samples

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

Get client invoices

rowId, foreignId, and the lastPaymentDateLower/lastPaymentDateUpper range are three mutually-exclusive lookup modes. At most one may be supplied, and none may be combined with the general filters (query, filter, invoiceDateLower/invoiceDateUpper, clientId, projectId, createdAfter/createdBefore/updatedAfter/updatedBefore). offset/limit apply only to the general list and the lastPaymentDate lookup; the rowId and foreignId lookups do not support them. Conflicting combinations are rejected with 400.

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
query
string
filter
string

Supported values: all, certified, certifiable, sendable, notPaid, paid

foreignId
string

Restrict the result to entities with this foreign ID. How it combines with the other parameters is endpoint-specific — see the operation description.

rowId
integer <int32>

Look up the single invoice containing this invoice row (at most one is returned). This is a standalone lookup mode: it cannot be combined with foreignId, the lastPaymentDate range, offset/limit, or the general filters (query/filter/invoiceDate/clientId/projectId/created/updated) — such combinations are rejected with 400.

invoiceDateLower
string
invoiceDateUpper
string
lastPaymentDateLower
string
lastPaymentDateUpper
string
clientId
string <uuid>
projectId
integer <int32>
ignoreFiles
boolean
offset
integer <int32>
limit
integer <int32>
createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "clientInvoices": [
    ]
}

Create client invoice

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
defaultDimensionsFromProduct
boolean
Default: true
defaultDimensionsFromClient
boolean
Default: false
header Parameters
requestId
string
Request Body schema: application/json
required
id
integer <int32>
foreignId
string
certified
boolean
certifiedDate
string
required
object (Client_REST_API_ClientReference)
object (Client_REST_API_ClientInvoiceTemplateReference)
currency
required
string
currencyRate
number <double>
amount
integer <int64>
vat
integer <int64>
object (Client_REST_API_ClientReference)
debitInvoiceNr
integer <int32>
deleteRowReferenceWhenCredit
boolean
object (Client_REST_API_ClientInvoiceReferences)
object (Client_REST_API_ClientInvoiceReferences)
object (Client_REST_API_Address)
deliveryDate
string
deliveryEmail
string
deliveryName
string
deliveryType
string (Client_REST_API_ClientDeliveryType)
Enum: "MAIL" "EDI" "EMAIL" "MANUALLY" "SVEA"
disabled
boolean
dueDate
string
invoiceNr
integer <int32>
object (Client_REST_API_Address)
countryCode
string
vatNr
string
invoiceDate
string
invoiceEmail
string
notes
string
object (Client_REST_API_UserReference)
object (Client_REST_API_UserReference)
poNr
string
agreementNr
string
subscriptionNr
string
remaining
integer <int64>
sent
boolean
yourReference
string
gln
string
object (Client_REST_API_ClientAgreementReference)
object (Client_REST_API_ClientInvoicePeriod)
object (Client_REST_API_Fields)
ediPeriodType
string
object (Client_REST_API_ClientInvoiceApproval)
object (Client_REST_API_ClientInvoiceFiles)
automaticActionsDisabled
boolean
automaticActionsMessage
string
object (Client_REST_API_ClientInvoiceDeliveries)
object (Client_REST_API_ClientInvoiceRows)
factoring
boolean
object (Client_REST_API_ClientInvoiceReinvoicings)
object (Client_REST_API_SupplierInvoiceRelation)
lastPaymentDate
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "certified": true,
  • "certifiedDate": "string",
  • "clientRef": {
    },
  • "clientInvoiceTemplateRef": {
    },
  • "currency": "string",
  • "currencyRate": 0.1,
  • "amount": 0,
  • "vat": 0,
  • "endClient": {
    },
  • "debitInvoiceNr": 0,
  • "deleteRowReferenceWhenCredit": true,
  • "creditInvoices": {
    },
  • "aggregatedInvoices": {
    },
  • "deliveryAddress": {
    },
  • "deliveryDate": "string",
  • "deliveryEmail": "string",
  • "deliveryName": "string",
  • "deliveryType": "MAIL",
  • "disabled": true,
  • "dueDate": "string",
  • "invoiceNr": 0,
  • "invoiceAddress": {
    },
  • "countryCode": "string",
  • "vatNr": "string",
  • "invoiceDate": "string",
  • "invoiceEmail": "string",
  • "notes": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "remaining": 0,
  • "sent": true,
  • "yourReference": "string",
  • "gln": "string",
  • "clientAgreementRef": {
    },
  • "period": {
    },
  • "fields": {
    },
  • "ediPeriodType": "string",
  • "approved": {
    },
  • "files": {
    },
  • "automaticActionsDisabled": true,
  • "automaticActionsMessage": "string",
  • "invoiceDeliveries": {
    },
  • "rows": {
    },
  • "factoring": true,
  • "reinvoicings": {
    },
  • "selfInvoiceReferences": {
    },
  • "lastPaymentDate": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "certified": true,
  • "certifiedDate": "string",
  • "clientRef": {
    },
  • "clientInvoiceTemplateRef": {
    },
  • "currency": "string",
  • "currencyRate": 0.1,
  • "amount": 0,
  • "vat": 0,
  • "endClient": {
    },
  • "debitInvoiceNr": 0,
  • "deleteRowReferenceWhenCredit": true,
  • "creditInvoices": {
    },
  • "aggregatedInvoices": {
    },
  • "deliveryAddress": {
    },
  • "deliveryDate": "string",
  • "deliveryEmail": "string",
  • "deliveryName": "string",
  • "deliveryType": "MAIL",
  • "disabled": true,
  • "dueDate": "string",
  • "invoiceNr": 0,
  • "invoiceAddress": {
    },
  • "countryCode": "string",
  • "vatNr": "string",
  • "invoiceDate": "string",
  • "invoiceEmail": "string",
  • "notes": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "remaining": 0,
  • "sent": true,
  • "yourReference": "string",
  • "gln": "string",
  • "clientAgreementRef": {
    },
  • "period": {
    },
  • "fields": {
    },
  • "ediPeriodType": "string",
  • "approved": {
    },
  • "files": {
    },
  • "automaticActionsDisabled": true,
  • "automaticActionsMessage": "string",
  • "invoiceDeliveries": {
    },
  • "rows": {
    },
  • "factoring": true,
  • "reinvoicings": {
    },
  • "selfInvoiceReferences": {
    },
  • "lastPaymentDate": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get client invoice by ID

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>
query Parameters
ignoreFiles
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "certified": true,
  • "certifiedDate": "string",
  • "clientRef": {
    },
  • "clientInvoiceTemplateRef": {
    },
  • "currency": "string",
  • "currencyRate": 0.1,
  • "amount": 0,
  • "vat": 0,
  • "endClient": {
    },
  • "debitInvoiceNr": 0,
  • "deleteRowReferenceWhenCredit": true,
  • "creditInvoices": {
    },
  • "aggregatedInvoices": {
    },
  • "deliveryAddress": {
    },
  • "deliveryDate": "string",
  • "deliveryEmail": "string",
  • "deliveryName": "string",
  • "deliveryType": "MAIL",
  • "disabled": true,
  • "dueDate": "string",
  • "invoiceNr": 0,
  • "invoiceAddress": {
    },
  • "countryCode": "string",
  • "vatNr": "string",
  • "invoiceDate": "string",
  • "invoiceEmail": "string",
  • "notes": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "remaining": 0,
  • "sent": true,
  • "yourReference": "string",
  • "gln": "string",
  • "clientAgreementRef": {
    },
  • "period": {
    },
  • "fields": {
    },
  • "ediPeriodType": "string",
  • "approved": {
    },
  • "files": {
    },
  • "automaticActionsDisabled": true,
  • "automaticActionsMessage": "string",
  • "invoiceDeliveries": {
    },
  • "rows": {
    },
  • "factoring": true,
  • "reinvoicings": {
    },
  • "selfInvoiceReferences": {
    },
  • "lastPaymentDate": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update client invoice

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>
query Parameters
defaultDimensionsFromProduct
boolean
Default: true
defaultDimensionsFromClient
boolean
Default: false
Request Body schema: application/json
required
id
integer <int32>
foreignId
string
certified
boolean
certifiedDate
string
required
object (Client_REST_API_ClientReference)
object (Client_REST_API_ClientInvoiceTemplateReference)
currency
required
string
currencyRate
number <double>
amount
integer <int64>
vat
integer <int64>
object (Client_REST_API_ClientReference)
debitInvoiceNr
integer <int32>
deleteRowReferenceWhenCredit
boolean
object (Client_REST_API_ClientInvoiceReferences)
object (Client_REST_API_ClientInvoiceReferences)
object (Client_REST_API_Address)
deliveryDate
string
deliveryEmail
string
deliveryName
string
deliveryType
string (Client_REST_API_ClientDeliveryType)
Enum: "MAIL" "EDI" "EMAIL" "MANUALLY" "SVEA"
disabled
boolean
dueDate
string
invoiceNr
integer <int32>
object (Client_REST_API_Address)
countryCode
string
vatNr
string
invoiceDate
string
invoiceEmail
string
notes
string
object (Client_REST_API_UserReference)
object (Client_REST_API_UserReference)
poNr
string
agreementNr
string
subscriptionNr
string
remaining
integer <int64>
sent
boolean
yourReference
string
gln
string
object (Client_REST_API_ClientAgreementReference)
object (Client_REST_API_ClientInvoicePeriod)
object (Client_REST_API_Fields)
ediPeriodType
string
object (Client_REST_API_ClientInvoiceApproval)
object (Client_REST_API_ClientInvoiceFiles)
automaticActionsDisabled
boolean
automaticActionsMessage
string
object (Client_REST_API_ClientInvoiceDeliveries)
object (Client_REST_API_ClientInvoiceRows)
factoring
boolean
object (Client_REST_API_ClientInvoiceReinvoicings)
object (Client_REST_API_SupplierInvoiceRelation)
lastPaymentDate
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "certified": true,
  • "certifiedDate": "string",
  • "clientRef": {
    },
  • "clientInvoiceTemplateRef": {
    },
  • "currency": "string",
  • "currencyRate": 0.1,
  • "amount": 0,
  • "vat": 0,
  • "endClient": {
    },
  • "debitInvoiceNr": 0,
  • "deleteRowReferenceWhenCredit": true,
  • "creditInvoices": {
    },
  • "aggregatedInvoices": {
    },
  • "deliveryAddress": {
    },
  • "deliveryDate": "string",
  • "deliveryEmail": "string",
  • "deliveryName": "string",
  • "deliveryType": "MAIL",
  • "disabled": true,
  • "dueDate": "string",
  • "invoiceNr": 0,
  • "invoiceAddress": {
    },
  • "countryCode": "string",
  • "vatNr": "string",
  • "invoiceDate": "string",
  • "invoiceEmail": "string",
  • "notes": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "remaining": 0,
  • "sent": true,
  • "yourReference": "string",
  • "gln": "string",
  • "clientAgreementRef": {
    },
  • "period": {
    },
  • "fields": {
    },
  • "ediPeriodType": "string",
  • "approved": {
    },
  • "files": {
    },
  • "automaticActionsDisabled": true,
  • "automaticActionsMessage": "string",
  • "invoiceDeliveries": {
    },
  • "rows": {
    },
  • "factoring": true,
  • "reinvoicings": {
    },
  • "selfInvoiceReferences": {
    },
  • "lastPaymentDate": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "certified": true,
  • "certifiedDate": "string",
  • "clientRef": {
    },
  • "clientInvoiceTemplateRef": {
    },
  • "currency": "string",
  • "currencyRate": 0.1,
  • "amount": 0,
  • "vat": 0,
  • "endClient": {
    },
  • "debitInvoiceNr": 0,
  • "deleteRowReferenceWhenCredit": true,
  • "creditInvoices": {
    },
  • "aggregatedInvoices": {
    },
  • "deliveryAddress": {
    },
  • "deliveryDate": "string",
  • "deliveryEmail": "string",
  • "deliveryName": "string",
  • "deliveryType": "MAIL",
  • "disabled": true,
  • "dueDate": "string",
  • "invoiceNr": 0,
  • "invoiceAddress": {
    },
  • "countryCode": "string",
  • "vatNr": "string",
  • "invoiceDate": "string",
  • "invoiceEmail": "string",
  • "notes": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "remaining": 0,
  • "sent": true,
  • "yourReference": "string",
  • "gln": "string",
  • "clientAgreementRef": {
    },
  • "period": {
    },
  • "fields": {
    },
  • "ediPeriodType": "string",
  • "approved": {
    },
  • "files": {
    },
  • "automaticActionsDisabled": true,
  • "automaticActionsMessage": "string",
  • "invoiceDeliveries": {
    },
  • "rows": {
    },
  • "factoring": true,
  • "reinvoicings": {
    },
  • "selfInvoiceReferences": {
    },
  • "lastPaymentDate": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete client invoice

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Approve client invoice

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Certify client invoice

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Send client invoice

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>
query Parameters
deliveryType
string
Enum: "MAIL" "EDI" "EMAIL" "MANUALLY" "SVEA"

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Create client invoice credit draft

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>
query Parameters
deleteRowReferenceWhenCredit
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "certified": true,
  • "certifiedDate": "string",
  • "clientRef": {
    },
  • "clientInvoiceTemplateRef": {
    },
  • "currency": "string",
  • "currencyRate": 0.1,
  • "amount": 0,
  • "vat": 0,
  • "endClient": {
    },
  • "debitInvoiceNr": 0,
  • "deleteRowReferenceWhenCredit": true,
  • "creditInvoices": {
    },
  • "aggregatedInvoices": {
    },
  • "deliveryAddress": {
    },
  • "deliveryDate": "string",
  • "deliveryEmail": "string",
  • "deliveryName": "string",
  • "deliveryType": "MAIL",
  • "disabled": true,
  • "dueDate": "string",
  • "invoiceNr": 0,
  • "invoiceAddress": {
    },
  • "countryCode": "string",
  • "vatNr": "string",
  • "invoiceDate": "string",
  • "invoiceEmail": "string",
  • "notes": "string",
  • "ourReference": {
    },
  • "approver": {
    },
  • "poNr": "string",
  • "agreementNr": "string",
  • "subscriptionNr": "string",
  • "remaining": 0,
  • "sent": true,
  • "yourReference": "string",
  • "gln": "string",
  • "clientAgreementRef": {
    },
  • "period": {
    },
  • "fields": {
    },
  • "ediPeriodType": "string",
  • "approved": {
    },
  • "files": {
    },
  • "automaticActionsDisabled": true,
  • "automaticActionsMessage": "string",
  • "invoiceDeliveries": {
    },
  • "rows": {
    },
  • "factoring": true,
  • "reinvoicings": {
    },
  • "selfInvoiceReferences": {
    },
  • "lastPaymentDate": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Register payment of a client invoice

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>
Request Body schema: application/json
required
date
string
invoiceAmount
integer <int64>
accountingAmount
integer <int64>
object (Client_REST_API_ClientInvoicePaymentTransactions)
object (Client_REST_API_ClientInvoiceFiles)

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "invoiceAmount": 0,
  • "accountingAmount": 0,
  • "transactions": {
    },
  • "files": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0
}

Create comment on client invoice

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>
Request Body schema: application/json
required
comment
required
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Add client invoice attachment

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>
Request Body schema: application/json
required
id
integer <int32>
filename
required
string
data
required
Array of integers

File data as array of byte values

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0
}

Get client invoice PDF

path Parameters
companyId
required
string <uuid>

The company UUID.

clientInvoiceId
required
integer <int32>

Responses

Response samples

Content type
application/problem+json
{}

Get products

foreignId is a lookup that returns the (active) products with that foreign id; it may be combined with active but not with cursor/limit or the createdAfter/createdBefore/updatedAfter/updatedBefore range filters, which apply only to the paged list. Conflicting combinations are rejected with 400.

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
foreignId
string

Restrict the result to entities with this foreign ID. How it combines with the other parameters is endpoint-specific — see the operation description.

active
boolean

When true, restrict the result to active entities only.

cursor
string <uuid>

Page token from a previous response's pagination.nextCursor. Omit for the first page.

limit
integer <int32> [ 0 .. 1000 ]
createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

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

Create product

path Parameters
companyId
required
string <uuid>

The company UUID.

Request Body schema: application/json
required
id
string <uuid>

Stable public identifier (ProductPublicId).

foreignId
string
name
string
type
string
unit
string
price
integer <int64>
object (Client_REST_API_DimensionEntriesUuid)
accountNr
integer <int32>
vatPercentage
number <double>
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "type": "string",
  • "unit": "string",
  • "price": 0,
  • "dimensionEntries": {
    },
  • "accountNr": 0,
  • "vatPercentage": 0.1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "type": "string",
  • "unit": "string",
  • "price": 0,
  • "dimensionEntries": {
    },
  • "accountNr": 0,
  • "vatPercentage": 0.1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get product by ID

path Parameters
companyId
required
string <uuid>

The company UUID.

productId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "type": "string",
  • "unit": "string",
  • "price": 0,
  • "dimensionEntries": {
    },
  • "accountNr": 0,
  • "vatPercentage": 0.1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update product

path Parameters
companyId
required
string <uuid>

The company UUID.

productId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>

Stable public identifier (ProductPublicId).

foreignId
string
name
string
type
string
unit
string
price
integer <int64>
object (Client_REST_API_DimensionEntriesUuid)
accountNr
integer <int32>
vatPercentage
number <double>
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "type": "string",
  • "unit": "string",
  • "price": 0,
  • "dimensionEntries": {
    },
  • "accountNr": 0,
  • "vatPercentage": 0.1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "type": "string",
  • "unit": "string",
  • "price": 0,
  • "dimensionEntries": {
    },
  • "accountNr": 0,
  • "vatPercentage": 0.1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

project

Get client projects

Returns a list of client projects for a company with optional filtering and pagination. Optionally filter by project number.

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
filter
string
Default: ""

Optional filter string

number
string

Filter by project number

cursor
string <uuid>

Page token from a previous response's pagination.nextCursor. Omit for the first page.

limit
integer <int32> >= 1

Maximum number of results to return

createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

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

Create a client project

Creates a new client project for the company

path Parameters
companyId
required
string <uuid>

The company UUID.

Request Body schema: application/json
required
clientId
string <uuid>
brokerClientId
string <uuid>
fixedPrice
required
boolean
name
required
string
number
string
currencyType
required
string
yourReference
string
ourReferenceUserId
string <uuid>
deliveryType
string
defaultNotes
string
comment
required
string
paymentDays
integer <int32>
poNr
string
budgetHours
required
integer <int64>
budgetAmount
required
integer <int64>
incomingInvoicedAmount
required
integer <int64>
incomingInvoicedVatAmount
required
integer <int64>
allActivities
required
boolean
allUsers
required
boolean
required
Array of objects (Project_REST_API_ClientProjectActivityWritable)
required
Array of objects (Project_REST_API_ClientProjectUserWritable)
required
Array of objects (Project_REST_API_LeadWritable)
Array of objects (Project_REST_API_FixedPricePlannedInvoiceWritable)
openingDate
string
closingDate
string
dimensionEntryId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "brokerClientId": "91b4fd21-2b45-475f-b396-130cc2a78158",
  • "fixedPrice": true,
  • "name": "string",
  • "number": "string",
  • "currencyType": "string",
  • "yourReference": "string",
  • "ourReferenceUserId": "c36e1575-8cd8-46d3-8758-3472fc682424",
  • "deliveryType": "string",
  • "defaultNotes": "string",
  • "comment": "string",
  • "paymentDays": 0,
  • "poNr": "string",
  • "budgetHours": 0,
  • "budgetAmount": 0,
  • "incomingInvoicedAmount": 0,
  • "incomingInvoicedVatAmount": 0,
  • "allActivities": true,
  • "allUsers": true,
  • "activities": [
    ],
  • "users": [
    ],
  • "leads": [
    ],
  • "fixedPricePlannedInvoices": [
    ],
  • "openingDate": "string",
  • "closingDate": "string",
  • "dimensionEntryId": "1a21846c-d2f0-4b93-86c1-5e404216fb2d"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get a single client project

Returns a single client project by its ID

path Parameters
companyId
required
string <uuid>

The company UUID.

clientProjectId
required
string <uuid>

The UUID of the client project

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "brokerClientId": "91b4fd21-2b45-475f-b396-130cc2a78158",
  • "fixedPrice": true,
  • "number": "string",
  • "name": "string",
  • "currencyType": "string",
  • "yourReference": "string",
  • "ourReferenceUserId": "c36e1575-8cd8-46d3-8758-3472fc682424",
  • "deliveryType": "string",
  • "defaultNotes": "string",
  • "email": "string",
  • "comment": "string",
  • "paymentDays": 0,
  • "poNr": "string",
  • "active": true,
  • "status": "string",
  • "budgetHours": 0,
  • "budgetAmount": 0,
  • "incomingInvoicedAmount": 0,
  • "incomingInvoicedVatAmount": 0,
  • "allActivities": true,
  • "allUsers": true,
  • "activities": [
    ],
  • "users": [
    ],
  • "leads": [
    ],
  • "fixedPricePlannedInvoices": [
    ],
  • "writeOffs": [
    ],
  • "dimensionEntryId": "1a21846c-d2f0-4b93-86c1-5e404216fb2d",
  • "openingDate": "string",
  • "closingDate": "string",
  • "updatedUserKey": "string",
  • "updatedDate": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update a client project

Updates an existing client project by its ID

path Parameters
companyId
required
string <uuid>

The company UUID.

clientProjectId
required
string <uuid>

The UUID of the client project

Request Body schema: application/json
required
clientId
string <uuid>
brokerClientId
string <uuid>
fixedPrice
required
boolean
name
required
string
number
string
currencyType
required
string
yourReference
string
ourReferenceUserId
string <uuid>
deliveryType
string
defaultNotes
string
comment
required
string
paymentDays
integer <int32>
poNr
string
budgetHours
required
integer <int64>
budgetAmount
required
integer <int64>
incomingInvoicedAmount
required
integer <int64>
incomingInvoicedVatAmount
required
integer <int64>
allActivities
required
boolean
allUsers
required
boolean
required
Array of objects (Project_REST_API_ClientProjectActivityWritable)
required
Array of objects (Project_REST_API_ClientProjectUserWritable)
required
Array of objects (Project_REST_API_LeadWritable)
Array of objects (Project_REST_API_FixedPricePlannedInvoiceWritable)
openingDate
string
closingDate
string
dimensionEntryId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  • "brokerClientId": "91b4fd21-2b45-475f-b396-130cc2a78158",
  • "fixedPrice": true,
  • "name": "string",
  • "number": "string",
  • "currencyType": "string",
  • "yourReference": "string",
  • "ourReferenceUserId": "c36e1575-8cd8-46d3-8758-3472fc682424",
  • "deliveryType": "string",
  • "defaultNotes": "string",
  • "comment": "string",
  • "paymentDays": 0,
  • "poNr": "string",
  • "budgetHours": 0,
  • "budgetAmount": 0,
  • "incomingInvoicedAmount": 0,
  • "incomingInvoicedVatAmount": 0,
  • "allActivities": true,
  • "allUsers": true,
  • "activities": [
    ],
  • "users": [
    ],
  • "leads": [
    ],
  • "fixedPricePlannedInvoices": [
    ],
  • "openingDate": "string",
  • "closingDate": "string",
  • "dimensionEntryId": "1a21846c-d2f0-4b93-86c1-5e404216fb2d"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get activities

Returns all active activities for a company

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

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

Get a single activity

Returns a single activity by its ID

path Parameters
companyId
required
string <uuid>

The company UUID.

activityId
required
string <uuid>

The activity UUID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "price": 0,
  • "invoiceProductId": "259a8dc3-8128-4ce6-8d4c-b79b8a568b56",
  • "mandatoryChildWhenReporting": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get internal hourly costs

Returns internal hourly costs for a user

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>

The ID of the user

Responses

Response samples

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

Set internal hourly costs

Sets the internal hourly costs for a user

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>

The ID of the user

Request Body schema: application/json
required
required
Array of objects (Project_REST_API_InternalHourlyCostWritable)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0
}

supplier

Get all suppliers

Returns a cursor-paginated page of active suppliers for a given company.

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

query Parameters
cursor
string <uuid>

Page token from a previous response's pagination.nextCursor. Omit for the first page.

limit
integer <int32> [ 1 .. 1000 ]

Maximum number of suppliers to return on this page.

foreignId
string

Exact-match filter by foreign id. Composes with the default active filter.

createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

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

Create a new supplier

Creates a new supplier for a given company

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

Request Body schema: application/json
required
foreignId
required
string

External identifier for the supplier

name
required
string

Supplier name

required
object (Supplier_REST_API_Address)

Address information

email
required
string

Supplier email address(es)

plusgiro
required
integer <int64>

Plusgiro account number

bankgiro
required
integer <int64>

Bankgiro account number

orgno
string

Organisation number

swedishBankAccount
required
string

Swedish bank account number

internationalBankAccountWithRouting
string

International bank account with routing number

internationalBankAccountWithAccountNumber
string

International bank account with account number

internationalBankAccountViaIntermediary
string

International bank account via intermediary

internationalBankAccountInRussiaInRub
string

International bank account in Russia in RUB

norwegianBankAccount
string

Norwegian bank account number

iban
required
string

International Bank Account Number (format BIC-IBAN)

object (Supplier_REST_API_UserReference)

Reference to a user

ourReference
string

Our reference

countryCode
string

Country code (ISO 3166-1 alpha-2)

vatNr
string

VAT number

accountNr
integer <int32>

Account number

object (Supplier_REST_API_BankAccountReference)

Reference to a bank account

Responses

Request samples

Content type
application/json
{
  • "foreignId": "string",
  • "name": "string",
  • "address": {
    },
  • "email": "string",
  • "plusgiro": 0,
  • "bankgiro": 0,
  • "orgno": "string",
  • "swedishBankAccount": "string",
  • "internationalBankAccountWithRouting": "string",
  • "internationalBankAccountWithAccountNumber": "string",
  • "internationalBankAccountViaIntermediary": "string",
  • "internationalBankAccountInRussiaInRub": "string",
  • "norwegianBankAccount": "string",
  • "iban": "string",
  • "user": {
    },
  • "ourReference": "string",
  • "countryCode": "string",
  • "vatNr": "string",
  • "accountNr": 0,
  • "bankAccount": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get supplier by ID

Returns a single supplier by its public ID for a given company

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierId
required
string <uuid>

The public ID of the supplier (SupplierPublicId UUID)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "address": {
    },
  • "email": "string",
  • "plusgiro": 0,
  • "bankgiro": 0,
  • "orgno": "string",
  • "swedishBankAccount": "string",
  • "internationalBankAccountWithRouting": "string",
  • "internationalBankAccountWithAccountNumber": "string",
  • "internationalBankAccountViaIntermediary": "string",
  • "internationalBankAccountInRussiaInRub": "string",
  • "norwegianBankAccount": "string",
  • "iban": "string",
  • "user": {
    },
  • "ourReference": "string",
  • "countryCode": "string",
  • "vatNr": "string",
  • "accountNr": 0,
  • "bankAccount": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update supplier by ID

Updates an existing supplier by its public ID for a given company

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierId
required
string <uuid>

The public ID of the supplier (SupplierPublicId UUID)

Request Body schema: application/json
required
id
required
string <uuid>

Stable public identifier (SupplierPublicId).

foreignId
required
string

External identifier for the supplier

name
required
string

Supplier name

required
object (Supplier_REST_API_Address)

Address information

email
required
string

Supplier email address(es)

plusgiro
required
integer <int64>

Plusgiro account number

bankgiro
required
integer <int64>

Bankgiro account number

orgno
string

Organisation number

swedishBankAccount
required
string

Swedish bank account number

internationalBankAccountWithRouting
string

International bank account with routing number

internationalBankAccountWithAccountNumber
string

International bank account with account number

internationalBankAccountViaIntermediary
string

International bank account via intermediary

internationalBankAccountInRussiaInRub
string

International bank account in Russia in RUB

norwegianBankAccount
string

Norwegian bank account number

iban
required
string

International Bank Account Number (format BIC-IBAN)

object (Supplier_REST_API_UserReference)

Reference to a user

ourReference
string

Our reference

countryCode
string

Country code (ISO 3166-1 alpha-2)

vatNr
string

VAT number

accountNr
integer <int32>

Account number

object (Supplier_REST_API_BankAccountReference)

Reference to a bank account

createdAt
string <date-time>

When the supplier was created (RFC 3339 / ISO-8601 with timezone offset; UTC).

updatedAt
string <date-time>

When the supplier was last updated (RFC 3339 / ISO-8601 with timezone offset; UTC).

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "foreignId": "string",
  • "name": "string",
  • "address": {
    },
  • "email": "string",
  • "plusgiro": 0,
  • "bankgiro": 0,
  • "orgno": "string",
  • "swedishBankAccount": "string",
  • "internationalBankAccountWithRouting": "string",
  • "internationalBankAccountWithAccountNumber": "string",
  • "internationalBankAccountViaIntermediary": "string",
  • "internationalBankAccountInRussiaInRub": "string",
  • "norwegianBankAccount": "string",
  • "iban": "string",
  • "user": {
    },
  • "ourReference": "string",
  • "countryCode": "string",
  • "vatNr": "string",
  • "accountNr": 0,
  • "bankAccount": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

subcontractor

Get all subcontractors

Returns a cursor-paginated page of subcontractors for a given company.

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

query Parameters
cursor
string <uuid>

Page token from a previous response's pagination.nextCursor. Omit for the first page.

limit
integer <int32> [ 1 .. 1000 ]

Maximum number of subcontractors to return on this page.

createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

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

Create a new subcontractor

Creates a new subcontractor for a given company

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

Request Body schema: application/json
required
required
object (Supplier_REST_API_SupplierReference)

Reference to a supplier

required
Array of objects (Supplier_REST_API_UserReference)

Responses

Request samples

Content type
application/json
{
  • "supplier": {
    },
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internalId": 0,
  • "supplier": {
    },
  • "users": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update subcontractor by ID

Updates an existing subcontractor by its public ID for a given company

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

subcontractorId
required
string <uuid>

The public ID of the subcontractor (SubcontractorPublicId UUID)

Request Body schema: application/json
required
required
object (Supplier_REST_API_SupplierReference)

Reference to a supplier

required
Array of objects (Supplier_REST_API_UserReference)

Responses

Request samples

Content type
application/json
{
  • "supplier": {
    },
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internalId": 0,
  • "supplier": {
    },
  • "users": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

supplier-invoice

Get supplier invoice by ID

Returns a single supplier invoice by its ID

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "supplierRef": {
    },
  • "bankAccountRef": {
    },
  • "yourReference": {
    },
  • "ourReference": "string",
  • "depositAccount": {
    },
  • "accountingDate": "2019-08-24",
  • "invoiceDate": "2019-08-24",
  • "dueDate": "2019-08-24",
  • "amount": 0,
  • "vat": 0,
  • "currency": "string",
  • "currencyRate": "string",
  • "poNr": "string",
  • "referenceNr": "string",
  • "ocr": "string",
  • "paymentDate": "2019-08-24",
  • "approvals": [
    ],
  • "certified": true,
  • "reminderType": "None",
  • "remaining": 0,
  • "payments": [
    ],
  • "accounts": [
    ],
  • "countryCode": "string",
  • "selfInvoiceReferenceIds": [
    ]
}

Update a supplier invoice

Updates an existing supplier invoice by ID

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

Request Body schema: application/json
required
foreignId
required
string

External identifier

supplierId
required
string <uuid>

Supplier public ID (SupplierPublicId UUID)

bankAccountId
integer <int64>

Bank account ID

yourReferenceUserId
string <uuid>

Your reference user UUID

ourReference
required
string

Our reference

required
object (Supplier_REST_API_SupplierInvoicePayee)

Payee information

accountingDate
string <date>

Accounting date

invoiceDate
required
string <date>

Invoice date

dueDate
required
string <date>

Due date

paymentDate
string <date>

Payment date

amount
required
integer <int64>

Amount in cents

vat
required
integer <int64>

VAT amount in cents

currency
required
string

Currency code

currencyRate
required
string

Currency rate

poNr
string

Purchase order number

referenceNr
string

Reference number

ocr
string

OCR number

reminderType
string
Enum: "None" "Reminder" "DebtCollection" "Enforcement"

Reminder type

required
Array of objects (Supplier_REST_API_SupplierInvoiceAccountWriteable)
clientInvoiceIds
Array of integers <int32> [ items <int32 > ]

Client invoice IDs for self-billing references

files
Array of strings <byte> [ items <byte > ]

PDF file data as base64-encoded strings

requestId
string

Idempotency request ID to prevent duplicate creation

Responses

Request samples

Content type
application/json
{
  • "foreignId": "string",
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "bankAccountId": 0,
  • "yourReferenceUserId": "a28dc7c6-5540-49ac-85d6-c396fe919de8",
  • "ourReference": "string",
  • "depositAccount": {
    },
  • "accountingDate": "2019-08-24",
  • "invoiceDate": "2019-08-24",
  • "dueDate": "2019-08-24",
  • "paymentDate": "2019-08-24",
  • "amount": 0,
  • "vat": 0,
  • "currency": "string",
  • "currencyRate": "string",
  • "poNr": "string",
  • "referenceNr": "string",
  • "ocr": "string",
  • "reminderType": "None",
  • "accounts": [
    ],
  • "clientInvoiceIds": [
    ],
  • "files": [
    ],
  • "requestId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get PDF for a supplier invoice

Returns the PDF document for a supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

Responses

Response samples

Content type
application/problem+json
{}

Get supplier invoice by account ID

Returns the supplier invoice associated with the given account ID

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

accountId
required
integer <int32>

The supplier invoice account ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "foreignId": "string",
  • "supplierRef": {
    },
  • "bankAccountRef": {
    },
  • "yourReference": {
    },
  • "ourReference": "string",
  • "depositAccount": {
    },
  • "accountingDate": "2019-08-24",
  • "invoiceDate": "2019-08-24",
  • "dueDate": "2019-08-24",
  • "amount": 0,
  • "vat": 0,
  • "currency": "string",
  • "currencyRate": "string",
  • "poNr": "string",
  • "referenceNr": "string",
  • "ocr": "string",
  • "paymentDate": "2019-08-24",
  • "approvals": [
    ],
  • "certified": true,
  • "reminderType": "None",
  • "remaining": 0,
  • "payments": [
    ],
  • "accounts": [
    ],
  • "countryCode": "string",
  • "selfInvoiceReferenceIds": [
    ]
}

Get supplier invoices by foreign ID

Returns supplier invoices matching the given foreign ID

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

foreignId
required
string

The foreign ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get supplier invoices

Returns supplier invoices with optional filters and pagination

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

query Parameters
startInvoiceDate
string <date>

Start of invoice date range (YYYY-MM-DD)

endInvoiceDate
string <date>

End of invoice date range (YYYY-MM-DD)

supplierId
string <uuid>

Filter by supplier public ID (SupplierPublicId UUID)

offset
integer <int32>

Pagination offset

limit
integer <int32>

Maximum number of results

Responses

Response samples

Content type
application/json
{
  • "supplierInvoices": [
    ],
  • "offset": 0,
  • "count": 0,
  • "totalCount": 0
}

Create a new supplier invoice

Creates a new supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

Request Body schema: application/json
required
foreignId
required
string

External identifier

supplierId
required
string <uuid>

Supplier public ID (SupplierPublicId UUID)

bankAccountId
integer <int64>

Bank account ID

yourReferenceUserId
string <uuid>

Your reference user UUID

ourReference
required
string

Our reference

required
object (Supplier_REST_API_SupplierInvoicePayee)

Payee information

accountingDate
string <date>

Accounting date

invoiceDate
required
string <date>

Invoice date

dueDate
required
string <date>

Due date

paymentDate
string <date>

Payment date

amount
required
integer <int64>

Amount in cents

vat
required
integer <int64>

VAT amount in cents

currency
required
string

Currency code

currencyRate
required
string

Currency rate

poNr
string

Purchase order number

referenceNr
string

Reference number

ocr
string

OCR number

reminderType
string
Enum: "None" "Reminder" "DebtCollection" "Enforcement"

Reminder type

required
Array of objects (Supplier_REST_API_SupplierInvoiceAccountWriteable)
clientInvoiceIds
Array of integers <int32> [ items <int32 > ]

Client invoice IDs for self-billing references

files
Array of strings <byte> [ items <byte > ]

PDF file data as base64-encoded strings

requestId
string

Idempotency request ID to prevent duplicate creation

Responses

Request samples

Content type
application/json
{
  • "foreignId": "string",
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "bankAccountId": 0,
  • "yourReferenceUserId": "a28dc7c6-5540-49ac-85d6-c396fe919de8",
  • "ourReference": "string",
  • "depositAccount": {
    },
  • "accountingDate": "2019-08-24",
  • "invoiceDate": "2019-08-24",
  • "dueDate": "2019-08-24",
  • "paymentDate": "2019-08-24",
  • "amount": 0,
  • "vat": 0,
  • "currency": "string",
  • "currencyRate": "string",
  • "poNr": "string",
  • "referenceNr": "string",
  • "ocr": "string",
  • "reminderType": "None",
  • "accounts": [
    ],
  • "clientInvoiceIds": [
    ],
  • "files": [
    ],
  • "requestId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get supplier invoices by purchase order number

Returns supplier invoices matching the given PO number

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

poNr
required
string

The purchase order number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get supplier invoices pending certification

Returns supplier invoices that are pending certification

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

query Parameters
offset
integer <int32>

Pagination offset

limit
integer <int32>

Maximum number of results

Responses

Response samples

Content type
application/json
{
  • "supplierInvoices": [
    ],
  • "offset": 0,
  • "count": 0,
  • "totalCount": 0
}

Get supplier invoices pending payment

Returns supplier invoices that are pending payment

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

query Parameters
offset
integer <int32>

Pagination offset

limit
integer <int32>

Maximum number of results

Responses

Response samples

Content type
application/json
{
  • "supplierInvoices": [
    ],
  • "offset": 0,
  • "count": 0,
  • "totalCount": 0
}

Certify a supplier invoice

Certifies a supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Pay a supplier invoice

Sends a payment for a supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

amount
required
integer <int64>

Payment amount in cents

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Pay a supplier invoice on a specific date

Sends a payment for a supplier invoice on a specified date

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

amount
required
integer <int64>

Payment amount in cents

date
required
string <date>

Payment date (YYYY-MM-DD)

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Pay a supplier invoice with a credit invoice

Pays a supplier invoice using a credit invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

creditSupplierInvoiceId
required
integer <int32>

The credit supplier invoice ID

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Upload a supplier invoice PDF

Uploads a PDF file to create a supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

query Parameters
interpret
boolean
Default: false

Whether to interpret the PDF content

Request Body schema: application/json
required
data
required
Array of integers

File data as array of byte values

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0
}

Update payee on a supplier invoice

Sets the payee information on a supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

Request Body schema: application/json
required
type
required
string
Enum: "BankGiro" "PlusGiro" "Iban" "BankAccount" "Other" "InternationalBankAccountWithRouting" "InternationalBankAccountWithAccountNumber" "InternationalBankAccountViaIntermediary" "InternationalBankAccountInRussiaInRub" "NorwegianBankAccount"

Deposit account type

nr
required
string

Account number

Responses

Request samples

Content type
application/json
{
  • "type": "BankGiro",
  • "nr": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Update self-billing references

Updates the self-billing (self-invoice) references on a supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

Request Body schema: application/json
required
clientInvoiceIds
Array of integers <int32> [ items <int32 > ]

Client invoice IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0
}

Cancel pending payments

Cancels all pending payments on a supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Approve or deny a supplier invoice

Approves or denies a supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

Request Body schema: application/json
required
approvalType
required
string
Enum: "APPROVAL" "DENIAL" "TIMEOUT"

Approval type

approvalNote
string

Approval note

Responses

Request samples

Content type
application/json
{
  • "approvalType": "APPROVAL",
  • "approvalNote": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Add an attachment to a supplier invoice

Adds a document attachment to a supplier invoice

path Parameters
companyId
required
string <uuid>

The ID of the company (UUID).

supplierInvoiceId
required
integer <int32>

The ID of the supplier invoice

attachmentName
required
string

Name of the attachment file

Request Body schema: application/json
required
data
required
Array of integers

File data as array of byte values

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0
}

expense

Get expenses

Returns expenses for the company filtered by date interval, free-text query, and expense filter.

path Parameters
companyId
required
integer <int32>

The ID of the company.

query Parameters
expenseDateStart
string <date>

Lower inclusive bound for expense date filtering.

expenseDateEnd
string <date>

Upper inclusive bound for expense date filtering.

query
string
Default: ""

Free-text query used when searching expenses.

filter
string (Expense_REST_API_ExpenseFilter)
Default: "Own"
Enum: "All" "Own" "Certified" "NotCertified" "Reimbursable"

Expense filter.

Responses

Response samples

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

Create expense

Creates an expense from existing expense entries.

path Parameters
companyId
required
integer <int32>

The ID of the company.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0
}

Get open expense files

Returns the unprocessed expense files for the current user.

path Parameters
companyId
required
integer <int32>

The ID of the company.

Responses

Response samples

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

Certify expense

Certifies the specified expense.

path Parameters
companyId
required
integer <int32>

The ID of the company.

expenseId
required
integer <int32>

The ID of the expense.

Responses

Response samples

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

Create expense file

Uploads a new expense file. If encoding is base64, the request body bytes are base64-decoded before processing.

path Parameters
companyId
required
integer <int32>

The ID of the company.

query Parameters
encoding
string
Value: "base64"

Optional request encoding. Use base64 when the uploaded request body is base64-encoded.

Request Body schema: application/octet-stream
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Get expense file data

Returns the original uploaded expense file bytes.

path Parameters
companyId
required
integer <int32>

The ID of the company.

expenseFileId
required
integer <int32>

The ID of the expense file.

Responses

Response samples

Content type
application/problem+json
{}

Delete expense file

Marks an expense file as processed/deleted.

path Parameters
companyId
required
integer <int32>

The ID of the company.

expenseFileId
required
integer <int32>

The ID of the expense file.

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Get expense file image

Returns the rendered image for an expense file. If encoding is base64, the response bytes are base64-encoded.

path Parameters
companyId
required
integer <int32>

The ID of the company.

expenseFileId
required
integer <int32>

The ID of the expense file.

query Parameters
encoding
string
Value: "base64"

Optional response encoding. Use base64 to receive base64-encoded bytes.

Responses

Response samples

Content type
application/problem+json
{}

Get expense entry form defaults

Returns defaults for creating an expense entry from a specific expense file.

path Parameters
companyId
required
integer <int32>

The ID of the company.

expenseFileId
required
integer <int32>

The ID of the expense file.

Responses

Response samples

Content type
application/json
{
  • "companyCard": {
    },
  • "date": "2019-08-24",
  • "type": {
    },
  • "description": "string",
  • "digital": true,
  • "currencyType": "string",
  • "countryCode": "string",
  • "dimensions": {
    }
}

Get expense entry

Returns a single expense entry.

path Parameters
companyId
required
integer <int32>

The ID of the company.

expenseEntryId
required
integer <int32>

The ID of the expense entry.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "expenseNr": 0,
  • "expenseFile": {
    },
  • "companyCard": {
    },
  • "expenseType": {
    },
  • "persons": {
    },
  • "date": "2019-08-24",
  • "description": "string",
  • "digital": true,
  • "amount": 0,
  • "vat": 0,
  • "currencyType": "string",
  • "currencyRate": 0,
  • "countryCode": "string",
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "periodStartDate": "2019-08-24",
  • "periodEndDate": "2019-08-24",
  • "dimensionEntries": {
    },
  • "reInvoicing": {
    }
}

Update expense entry

Updates an existing expense entry.

path Parameters
companyId
required
integer <int32>

The ID of the company.

expenseEntryId
required
integer <int32>

The ID of the expense entry.

Request Body schema: application/json
required
required
object (Expense_REST_API_ExpenseFileReference)
object (Expense_REST_API_CompanyCardReference)
required
object (Expense_REST_API_ExpenseTypeReference)
object (Expense_REST_API_PersonNames)
date
required
string <date>
description
required
string
digital
required
boolean
amount
required
integer <int64>
vat
required
integer <int64>
currencyType
required
string
countryCode
required
string
required
object (Expense_REST_API_ExpenseEntryWritableDimensionEntries)
object (Expense_REST_API_ExpenseEntryWritableReInvoicing)

Responses

Request samples

Content type
application/json
{
  • "expenseFile": {
    },
  • "companyCard": {
    },
  • "expenseType": {
    },
  • "persons": {
    },
  • "date": "2019-08-24",
  • "description": "string",
  • "digital": true,
  • "amount": 0,
  • "vat": 0,
  • "currencyType": "string",
  • "countryCode": "string",
  • "dimensionEntries": {
    },
  • "reInvoicing": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0
}

Delete expense entry

Deletes an expense entry that does not belong to an expense.

path Parameters
companyId
required
integer <int32>

The ID of the company.

expenseEntryId
required
integer <int32>

The ID of the expense entry.

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Create expense entry

Creates a new expense entry.

path Parameters
companyId
required
integer <int32>

The ID of the company.

Request Body schema: application/json
required
required
object (Expense_REST_API_ExpenseFileReference)
object (Expense_REST_API_CompanyCardReference)
required
object (Expense_REST_API_ExpenseTypeReference)
object (Expense_REST_API_PersonNames)
date
required
string <date>
description
required
string
digital
required
boolean
amount
required
integer <int64>
vat
required
integer <int64>
currencyType
required
string
countryCode
required
string
required
object (Expense_REST_API_ExpenseEntryWritableDimensionEntries)
object (Expense_REST_API_ExpenseEntryWritableReInvoicing)

Responses

Request samples

Content type
application/json
{
  • "expenseFile": {
    },
  • "companyCard": {
    },
  • "expenseType": {
    },
  • "persons": {
    },
  • "date": "2019-08-24",
  • "description": "string",
  • "digital": true,
  • "amount": 0,
  • "vat": 0,
  • "currencyType": "string",
  • "countryCode": "string",
  • "dimensionEntries": {
    },
  • "reInvoicing": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get open expense entries

Returns sorted open expense entries for the current user.

path Parameters
companyId
required
integer <int32>

The ID of the company.

Responses

Response samples

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

Get expense entry form

Returns the reference data needed to create or edit expense entries.

path Parameters
companyId
required
integer <int32>

The ID of the company.

Responses

Response samples

Content type
application/json
{
  • "companyCards": {
    },
  • "expenseTypes": {
    },
  • "currencyTypes": {
    },
  • "countries": {
    },
  • "dimensions": {
    },
  • "reInvoicing": {
    }
}

Get entries for an expense

Returns the non-deleted expense entries for a specific expense number.

path Parameters
companyId
required
integer <int32>

The ID of the company.

expenseNr
required
integer <int32>

The expense number.

Responses

Response samples

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

revenue

Create a new revenue

Creates a new revenue record for a given company

path Parameters
companyId
required
integer <int32>

The ID of the company

query Parameters
defaultDimensionsFromProduct
boolean
Default: true

Whether to use default dimensions from product

defaultDimensionsFromClient
boolean
Default: false

Whether to use default dimensions from client

Request Body schema: application/json
required
object (Revenue_REST_API_RevenueReference)

Reference to a revenue by ID or external ID

required
object (Revenue_REST_API_RevenueLedgerReference)
externalId
required
string

External reference ID

object (Revenue_REST_API_ClientReference)
object (Revenue_REST_API_NewClient)
countryCode
required
string

Country code (e.g., SE, NO, DK)

transactionDate
required
string <date>

Transaction date in ISO format (YYYY-MM-DD)

Array of objects (Revenue_REST_API_RevenueCreateRow)
required
Array of objects (Revenue_REST_API_RevenueFile)

Responses

Request samples

Content type
application/json
{
  • "debitRevenue": {
    },
  • "ledger": {
    },
  • "externalId": "string",
  • "client": {
    },
  • "newClient": {
    },
  • "countryCode": "string",
  • "transactionDate": "2019-08-24",
  • "rows": [
    ],
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}

Update an existing revenue

Updates an existing revenue record. Provide the full revenue data along with a message explaining the reason for the update.

path Parameters
companyId
required
integer <int32>

The ID of the company

query Parameters
defaultDimensionsFromProduct
boolean
Default: true

Whether to use default dimensions from product

defaultDimensionsFromClient
boolean
Default: false

Whether to use default dimensions from client

Request Body schema: application/json
required
required
object (Revenue_REST_API_RevenueCreate)
message
required
string

Reason for the update

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0
}

Get revenue by ID

Retrieves a specific revenue record by its ID for a given company

path Parameters
companyId
required
integer <int32>

The ID of the company

revenueId
required
integer <int32>

The ID of the revenue to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "ledger": {
    },
  • "externalId": "string",
  • "revision": 0,
  • "client": {
    },
  • "countryCode": "SE",
  • "transactionDate": "2019-08-24",
  • "remainingAccountingAmount": 0,
  • "rows": [
    ]
}

Consolidate a credit

Consolidates a credit revenue with its associated debit

path Parameters
companyId
required
integer <int32>

The ID of the company

revenueId
required
integer <int32>

The ID of the credit revenue to consolidate

Responses

Response samples

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

Delete a consolidated credit

Deletes the consolidation of a credit revenue (idempotent operation)

path Parameters
companyId
required
integer <int32>

The ID of the company

revenueId
required
integer <int32>

The ID of the credit revenue

Responses

Response samples

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

Find all revenue ledgers

Retrieves all revenue ledgers for a company with pagination

path Parameters
companyId
required
integer <int32>

The ID of the company

query Parameters
offset
integer <int32> >= 0
Default: 0

Pagination offset (0-based)

limit
integer <int32> [ 1 .. 100 ]
Default: 100

Maximum number of ledgers to return

Responses

Response samples

Content type
application/json
{
  • "ledgers": [
    ],
  • "offset": 0,
  • "limit": 0,
  • "size": 0
}

Get revenue by external ID

Retrieves a revenue record by its external ID within a specific ledger

path Parameters
companyId
required
integer <int32>

The ID of the company

ledgerId
required
integer <int32>

The ID of the ledger

externalId
required
string

The external ID of the revenue to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "ledger": {
    },
  • "externalId": "string",
  • "revision": 0,
  • "client": {
    },
  • "countryCode": "SE",
  • "transactionDate": "2019-08-24",
  • "remainingAccountingAmount": 0,
  • "rows": [
    ]
}

Find revenues in a ledger

Retrieves revenues for a specific ledger with pagination and filtering

path Parameters
companyId
required
integer <int32>

The ID of the company

ledgerId
required
integer <int32>

The ID of the ledger

query Parameters
filter
string
Default: "all"
Enum: "all" "notPaid" "paid"

Filter to apply to the revenues

offset
integer <int32> >= 0
Default: 0

Pagination offset (0-based)

limit
integer <int32> [ 1 .. 100 ]
Default: 100

Maximum number of revenues to return

lowerDate
string <date>

Lower bound date filter (inclusive)

upperDate
string <date>

Upper bound date filter (inclusive)

Responses

Response samples

Content type
application/json
{
  • "revenues": [
    ],
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "aggregation": {
    }
}

Create fuzzy consolidation

Creates a fuzzy consolidation between revenues and bank transactions. All given bank transactions and revenues will be fully consolidated.

path Parameters
companyId
required
integer <int32>

The ID of the company

Request Body schema: application/json
required
required
Array of objects (Revenue_REST_API_RevenueReference)
required
Array of objects (Revenue_REST_API_BankTransactionReference)
required
object (Revenue_REST_API_RevenueTransactionFees)
object (Revenue_REST_API_PreviousLedger)
fxAmount
integer <int64>

Foreign exchange amount

required
Array of objects (Revenue_REST_API_RevenueFile)

Responses

Request samples

Content type
application/json
{
  • "revenueReferences": [
    ],
  • "bankTransactionReferences": [
    ],
  • "transactionFees": {
    },
  • "previousLedger": {
    },
  • "fxAmount": 0,
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "bankTransactionCount": 0,
  • "revenueCount": 0,
  • "bankTransactionAccountingAmount": 0,
  • "revenueAccountingAmount": 0
}

bank

Get active bank accounts

Returns a list of active bank accounts that have a balance account number. These are considered "confirmed" bank accounts.

path Parameters
companyId
required
string <uuid>

The company UUID

Responses

Response samples

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

Get bank transactions

Returns a paginated list of bank transactions for a specific bank account

path Parameters
companyId
required
string <uuid>

The company UUID

accountId
required
integer <int64>

The ID of the bank account

query Parameters
ignoreFiles
boolean
Default: false

Whether to exclude file data from the response

dateLower
string <date>

Lower bound for transaction date filter (inclusive)

dateUpper
string <date>

Upper bound for transaction date filter (inclusive)

offset
integer <int32> >= 0
Default: 0

The offset into the full result set (0-indexed)

limit
integer <int32> [ 1 .. 1000 ]
Default: 1000

Maximum number of transactions to return

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "bankTransactions": [
    ]
}

Get open bank transactions

Returns a paginated list of open (unfinished) bank transactions for a specific bank account

path Parameters
companyId
required
string <uuid>

The company UUID

accountId
required
integer <int64>

The ID of the bank account

query Parameters
ignoreFiles
boolean
Default: false

Whether to exclude file data from the response

offset
integer <int32> >= 0
Default: 0

The offset into the full result set (0-indexed)

limit
integer <int32> [ 1 .. 1000 ]
Default: 1000

Maximum number of transactions to return

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "bankTransactions": [
    ]
}

Get finished bank transactions

Returns a paginated list of finished bank transactions for a specific bank account

path Parameters
companyId
required
string <uuid>

The company UUID

accountId
required
integer <int64>

The ID of the bank account

query Parameters
ignoreFiles
boolean
Default: false

Whether to exclude file data from the response

dateLower
string <date>

Lower bound for transaction date filter (inclusive)

dateUpper
string <date>

Upper bound for transaction date filter (inclusive)

offset
integer <int32> >= 0
Default: 0

The offset into the full result set (0-indexed)

limit
integer <int32> [ 1 .. 1000 ]
Default: 1000

Maximum number of transactions to return

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "bankTransactions": [
    ]
}

Get deleted bank transactions

Returns a paginated list of deleted bank transactions for a specific bank account

path Parameters
companyId
required
string <uuid>

The company UUID

accountId
required
integer <int64>

The ID of the bank account

query Parameters
ignoreFiles
boolean
Default: false

Whether to exclude file data from the response

offset
integer <int32> >= 0
Default: 0

The offset into the full result set (0-indexed)

limit
integer <int32> [ 1 .. 1000 ]
Default: 1000

Maximum number of transactions to return

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "bankTransactions": [
    ]
}

Create a bank transaction

Creates a manual bank transaction with optional file attachments (PDF files will be merged if multiple are provided).

path Parameters
companyId
required
string <uuid>

The company UUID

Request Body schema: application/json
required
bankAccountId
required
integer <int64>

ID of the bank account

date
required
string <date>

Transaction date

amount
required
integer <int64>

Transaction amount in cents

reference
required
string

Transaction reference

description
required
string

Transaction description

required
object

Container for file attachments

Responses

Request samples

Content type
application/json
{
  • "bankAccountId": 0,
  • "date": "2019-08-24",
  • "amount": 0,
  • "reference": "string",
  • "description": "string",
  • "files": {
    }
}

Response samples

Content type
application/json
{
  • "id": {
    },
  • "bankAccount": {
    },
  • "company": {
    },
  • "date": "2019-08-24",
  • "amount": 0,
  • "remainingAmount": 0,
  • "reference": "string",
  • "description": "string",
  • "deleted": true,
  • "deletedDate": "2019-08-24",
  • "voucher": {
    },
  • "comments": {
    },
  • "messages": {
    },
  • "files": {
    },
  • "bgcMetadata": {
    },
  • "endToEndId": "string"
}

Validate bank information

Validates bank account information (BIC/IBAN or supplier invoice account) according to internal logic.

path Parameters
companyId
required
string <uuid>

The company UUID

Request Body schema: application/json
required
object (Bank_REST_API_BicIban)

BIC and IBAN combination for international bank accounts

object (Bank_REST_API_SupplierInvoicePayee)

Supplier invoice payee account information

Responses

Request samples

Content type
application/json
{
  • "bicIban": {
    },
  • "supplierInvoiceAccount": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Connect transaction to client invoice

Creates a distribution connecting a bank transaction to a client invoice.

path Parameters
companyId
required
string <uuid>

The company UUID

transactionId
required
integer <int64>

The ID of the bank transaction

invoiceId
required
integer <int32>

The ID of the client invoice

Responses

Response samples

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

Consolidate revenues for a transaction

Creates distributions consolidating revenues for a bank transaction. Optionally validates full consolidation.

path Parameters
companyId
required
string <uuid>

The company UUID

transactionId
required
integer <int64>

The ID of the bank transaction

Request Body schema: application/json
required
requireFullConsolidation
required
boolean

Whether to require full consolidation (validates all amounts match)

Array of objects (Bank_REST_API_ConsolidateRevenueEntry)

List of revenue distributions to create

required
Array of objects (Bank_REST_API_File)

File attachments

Responses

Request samples

Content type
application/json
{
  • "requireFullConsolidation": true,
  • "revenue": [
    ],
  • "file": [
    ]
}

Response samples

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

Get distributions for a transaction

Returns all distributions associated with a bank transaction.

path Parameters
companyId
required
string <uuid>

The company UUID

transactionId
required
integer <int64>

The ID of the bank transaction

Responses

Response samples

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

Delete a single transaction distribution

Deletes a specific bank transaction distribution by its ID.

path Parameters
companyId
required
string <uuid>

The company UUID

transactionDitributionId
required
integer <int64>

The ID of the bank transaction distribution

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Delete all distributions for a transaction

Deletes all distributions associated with a bank transaction.

path Parameters
companyId
required
string <uuid>

The company UUID

transactionId
required
integer <int64>

The ID of the bank transaction

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

payroll

Get payroll articles

path Parameters
companyId
required
string <uuid>

The company UUID.

Responses

Response samples

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

Create a payroll event for a user

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>
Request Body schema: application/json
required
date
required
string <date>
hours
required
number
type
required
string (Payroll_REST_API_PayrollEventType)
Enum: "Sick" "Vacation" "LeaveOfAbsence" "LeaveOfAbsenceVacationEarned" "WorkHour" "ParentalLeave" "Childcare" "CloseRelativeCare" "PaternityLeave" "Furlough" "OtherLeave" "OtherLeaveVacationNotEarned"
child
string
comment
required
string

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "hours": 0,
  • "type": "Sick",
  • "child": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Delete a payroll event

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>
eventId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0
}

Get payroll events for a user in an interval

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>
fromDate
required
string <date>
toDate
required
string <date>

Responses

Response samples

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

Create a child for a payroll user

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>
Request Body schema: application/json
required
name
required
string
birthDate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "birthDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get employment contract by user id

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "ssn": "string",
  • "address1": "string",
  • "address2": "string",
  • "zipCode": "string",
  • "state": "string",
  • "countryCode": "string",
  • "phone": "string",
  • "taxTable": 0,
  • "taxTableColumn": 0,
  • "taxPercentage": 0,
  • "taxPercentageValidFrom": "2019-08-24",
  • "taxPercentageValidTo": "2019-08-24",
  • "oneTimeTaxPercentage": 0,
  • "clearingNr": "string",
  • "accountNr": "string",
  • "employmentStartDate": "2019-08-24",
  • "employmentEndDate": "2019-08-24",
  • "notes": "string",
  • "travelReimbursementPerMile": 0,
  • "expenseAllowance": true,
  • "fuelBenefit": true,
  • "monthlySalaryType": "Next",
  • "monthlySalary": 0,
  • "monthlySalaryStartDate": "2019-08-24",
  • "monthlySalaryYearlyPension": 0,
  • "hourlySalary": 0,
  • "hourlySalaryStartDate": "2019-08-24",
  • "variableSalaryType": "Disabled",
  • "variableSalaryPayoutType": "Current",
  • "variableSalaryInputType": "Self",
  • "variableSalaryDescription": "string",
  • "variableSaleryTaxType": "Normal",
  • "variableSaleryProvisionVacationPercentage": 0,
  • "provision": true,
  • "monthReportStrategy": "DontCreate",
  • "managerUser": {
    },
  • "workplaceNumber": "string",
  • "workplaceCustomAddress": "string",
  • "workplaceCustomLocality": "string",
  • "vacationFixedDebtPercentage": 0,
  • "vacationEntitlement": 0,
  • "vacationPaidDays": 0,
  • "vacationPaidDaysUsed": 0,
  • "vacationAdvanceDays": 0,
  • "vacationAdvanceDaysUsed": 0,
  • "vacationAdvanceDaysPreviousYear": 0,
  • "vacationSavedDays": 0,
  • "vacationSavedDaysYear1": 0,
  • "vacationSavedDaysYear2": 0,
  • "vacationSavedDaysYear3": 0,
  • "vacationSavedDaysYear4": 0,
  • "vacationSavedDaysYear5": 0,
  • "vacationSavedDaysUsed": 0,
  • "vacationUnpaidDays": 0,
  • "vacationUnpaidDaysUsed": 0,
  • "schedules": [
    ],
  • "dimensionEntries": [
    ],
  • "vacationEntitlements": [
    ],
  • "children": [
    ],
  • "fullHistoryMonthlySalaries": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create a payroll user

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>
Request Body schema: application/json
required
ssn
string
address1
string
address2
string
zipCode
string
state
string
countryCode
string
phone
string
taxTable
integer <int32>
taxTableColumn
integer <int32>
taxPercentage
number
taxPercentageValidFrom
string <date>
taxPercentageValidTo
string <date>
oneTimeTaxPercentage
number
clearingNr
string
accountNr
string
employmentStartDate
string <date>
object (Payroll_REST_API_PayrollUserWritableEmploymentEndDate)
notes
string
travelReimbursementPerMile
integer <int64>
expenseAllowance
boolean
fuelBenefit
boolean
monthlySalaryType
string (Payroll_REST_API_PayrollUserMonthlySalaryType)
Enum: "Next" "Current"
monthlySalary
integer <int64>
monthlySalaryStartDate
string <date>
monthlySalaryYearlyPension
integer <int64>
hourlySalary
integer <int64>
hourlySalaryStartDate
string <date>
provision
boolean
monthReportStrategy
string (Payroll_REST_API_PayrollUserMonthReportStrategy)
Enum: "DontCreate" "Create" "CreateApproveSelf"
Array of objects (Payroll_REST_API_PayrollUserSchedule)
Array of objects (Payroll_REST_API_DimensionEntryReference)
object (Payroll_REST_API_UserReference)
object (Payroll_REST_API_VacationEntitlement)
workplaceNumber
string
workplaceCustomAddress
string
workplaceCustomLocality
string

Responses

Request samples

Content type
application/json
{
  • "ssn": "string",
  • "address1": "string",
  • "address2": "string",
  • "zipCode": "string",
  • "state": "string",
  • "countryCode": "string",
  • "phone": "string",
  • "taxTable": 0,
  • "taxTableColumn": 0,
  • "taxPercentage": 0,
  • "taxPercentageValidFrom": "2019-08-24",
  • "taxPercentageValidTo": "2019-08-24",
  • "oneTimeTaxPercentage": 0,
  • "clearingNr": "string",
  • "accountNr": "string",
  • "employmentStartDate": "2019-08-24",
  • "employmentEndDate": {
    },
  • "notes": "string",
  • "travelReimbursementPerMile": 0,
  • "expenseAllowance": true,
  • "fuelBenefit": true,
  • "monthlySalaryType": "Next",
  • "monthlySalary": 0,
  • "monthlySalaryStartDate": "2019-08-24",
  • "monthlySalaryYearlyPension": 0,
  • "hourlySalary": 0,
  • "hourlySalaryStartDate": "2019-08-24",
  • "provision": true,
  • "monthReportStrategy": "DontCreate",
  • "schedules": [
    ],
  • "dimensionEntries": [
    ],
  • "managerUser": {
    },
  • "vacationEntitlement": {
    },
  • "workplaceNumber": "string",
  • "workplaceCustomAddress": "string",
  • "workplaceCustomLocality": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Update a payroll user

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>
Request Body schema: application/json
required
ssn
string
address1
string
address2
string
zipCode
string
state
string
countryCode
string
phone
string
taxTable
integer <int32>
taxTableColumn
integer <int32>
taxPercentage
number
taxPercentageValidFrom
string <date>
taxPercentageValidTo
string <date>
oneTimeTaxPercentage
number
clearingNr
string
accountNr
string
employmentStartDate
string <date>
object (Payroll_REST_API_PayrollUserWritableEmploymentEndDate)
notes
string
travelReimbursementPerMile
integer <int64>
expenseAllowance
boolean
fuelBenefit
boolean
monthlySalaryType
string (Payroll_REST_API_PayrollUserMonthlySalaryType)
Enum: "Next" "Current"
monthlySalary
integer <int64>
monthlySalaryStartDate
string <date>
monthlySalaryYearlyPension
integer <int64>
hourlySalary
integer <int64>
hourlySalaryStartDate
string <date>
provision
boolean
monthReportStrategy
string (Payroll_REST_API_PayrollUserMonthReportStrategy)
Enum: "DontCreate" "Create" "CreateApproveSelf"
Array of objects (Payroll_REST_API_PayrollUserSchedule)
Array of objects (Payroll_REST_API_DimensionEntryReference)
object (Payroll_REST_API_UserReference)
object (Payroll_REST_API_VacationEntitlement)
workplaceNumber
string
workplaceCustomAddress
string
workplaceCustomLocality
string

Responses

Request samples

Content type
application/json
{
  • "ssn": "string",
  • "address1": "string",
  • "address2": "string",
  • "zipCode": "string",
  • "state": "string",
  • "countryCode": "string",
  • "phone": "string",
  • "taxTable": 0,
  • "taxTableColumn": 0,
  • "taxPercentage": 0,
  • "taxPercentageValidFrom": "2019-08-24",
  • "taxPercentageValidTo": "2019-08-24",
  • "oneTimeTaxPercentage": 0,
  • "clearingNr": "string",
  • "accountNr": "string",
  • "employmentStartDate": "2019-08-24",
  • "employmentEndDate": {
    },
  • "notes": "string",
  • "travelReimbursementPerMile": 0,
  • "expenseAllowance": true,
  • "fuelBenefit": true,
  • "monthlySalaryType": "Next",
  • "monthlySalary": 0,
  • "monthlySalaryStartDate": "2019-08-24",
  • "monthlySalaryYearlyPension": 0,
  • "hourlySalary": 0,
  • "hourlySalaryStartDate": "2019-08-24",
  • "provision": true,
  • "monthReportStrategy": "DontCreate",
  • "schedules": [
    ],
  • "dimensionEntries": [
    ],
  • "managerUser": {
    },
  • "vacationEntitlement": {
    },
  • "workplaceNumber": "string",
  • "workplaceCustomAddress": "string",
  • "workplaceCustomLocality": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get employment contracts

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
offset
integer <int32> >= 0
Default: 0

The first payroll user result offset. Defaults to 0.

limit
integer <int32> [ 1 .. 100 ]
Default: 100

The maximum number of payroll users to return. Defaults to 100 and is capped at 100.

createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "payrollUserReadable": [
    ]
}

Get payroll runs

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
startDate
string <date>
endDate
string <date>
offset
integer <int32> >= 0
Default: 0
limit
integer <int32> [ 1 .. 1000 ]
Default: 1000

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "payrollRun": [
    ]
}

Create a payroll run

path Parameters
companyId
required
string <uuid>

The company UUID.

Request Body schema: application/json
required
paymentDate
required
string <date>
required
Array of objects (Payroll_REST_API_PayrollRunCreatePayout)

Responses

Request samples

Content type
application/json
{
  • "paymentDate": "2019-08-24",
  • "payouts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get open payroll runs

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
offset
integer <int32> >= 0
Default: 0

The first open payroll run result offset. Defaults to 0.

limit
integer <int32> [ 1 .. 100 ]
Default: 100

The maximum number of open payroll runs to return. Defaults to 100 and is capped at 100.

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "payrollRun": [
    ]
}

Get a payroll run

path Parameters
companyId
required
string <uuid>

The company UUID.

runId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "nr": 0,
  • "paymentDate": "2019-08-24",
  • "payouts": [
    ],
  • "paid": {
    },
  • "info": "string"
}

Pay a payroll run

path Parameters
companyId
required
string <uuid>

The company UUID.

runId
required
integer <int32>
Request Body schema: application/json
optional
paymentDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "paymentDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Bookkeep a payroll run

path Parameters
companyId
required
string <uuid>

The company UUID.

runId
required
integer <int32>
Request Body schema: application/json
optional
paymentDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "paymentDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get payroll run PDF

path Parameters
companyId
required
string <uuid>

The company UUID.

runId
required
integer <int32>

Responses

Response samples

Content type
application/problem+json
{}

Get payroll payout transactions

path Parameters
companyId
required
string <uuid>

The company UUID.

payoutId
required
integer <int32>
query Parameters
offset
required
integer <int32> >= 0
limit
required
integer <int32> [ 1 .. 1000 ]

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "size": 0,
  • "payrollTransaction": [
    ]
}

Get payroll month report for a user and month

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>
year
required
integer <int32>
month
required
integer <int32>

Legacy payroll calendar month where January is 0 and December is 11.

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "year": 0,
  • "month": 0,
  • "provisions": [
    ],
  • "notes": "string",
  • "gross": 0,
  • "benefits": 0,
  • "payout": 0,
  • "tax": 0,
  • "socialFees": 0,
  • "articles": [
    ],
  • "approved": {
    },
  • "certified": {
    }
}

Save payroll month report for a user and month

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>
year
required
integer <int32>
month
required
integer <int32>

Legacy payroll calendar month where January is 0 and December is 11.

Request Body schema: application/json
required
Array of objects (Payroll_REST_API_PayrollMonthReportProvision)
Array of objects (Payroll_REST_API_PayrollMonthReportArticle)

Responses

Request samples

Content type
application/json
{
  • "provisions": [
    ],
  • "articles": [
    ]
}

Response samples

Content type
application/problem+json
{}

Get open payroll month reports

path Parameters
companyId
required
string <uuid>

The company UUID.

Responses

Response samples

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

Get work schedules

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

Responses

Response samples

Content type
application/json
{
  • "fixedSchedule": [
    ],
  • "rollingSchedule": [
    ]
}

Create a rolling payroll schedule

path Parameters
companyId
required
string <uuid>

The company UUID.

Request Body schema: application/json
required
name
required
string
description
required
string
Array of objects (Payroll_REST_API_PayrollRollingScheduleInterval)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "intervals": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}

Create a fixed payroll schedule

path Parameters
companyId
required
string <uuid>

The company UUID.

Request Body schema: application/json
required
name
required
string
description
required
string
hoursPerWeek
number
daysPerWeek
number
levelOfEmployment
number
Array of objects (Payroll_REST_API_PayrollFixedScheduleInterval)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "hoursPerWeek": 0,
  • "daysPerWeek": 0,
  • "levelOfEmployment": 0,
  • "intervals": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get a work schedule

path Parameters
companyId
required
string <uuid>

The company UUID.

scheduleId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "fixedSchedule": {
    },
  • "rollingSchedule": {
    }
}

Update a payroll schedule

path Parameters
companyId
required
string <uuid>

The company UUID.

scheduleId
required
integer <int32>
Request Body schema: application/json
required
name
required
string
description
required
string
hoursPerWeek
number
daysPerWeek
number
levelOfEmployment
number
Array of objects (Payroll_REST_API_PayrollScheduleIntervalWritable)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "hoursPerWeek": 0,
  • "daysPerWeek": 0,
  • "levelOfEmployment": 0,
  • "intervals": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get payroll user schedule metadata for an interval

path Parameters
companyId
required
string <uuid>

The company UUID.

userId
required
integer <int32>
startDate
required
string <date>
endDate
required
string <date>

Responses

Response samples

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

Append intervals to a fixed payroll schedule

path Parameters
companyId
required
string <uuid>

The company UUID.

scheduleId
required
integer <int32>
Request Body schema: application/json
required
name
required
string
description
required
string
hoursPerWeek
number
daysPerWeek
number
levelOfEmployment
number
Array of objects (Payroll_REST_API_PayrollFixedScheduleInterval)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "hoursPerWeek": 0,
  • "daysPerWeek": 0,
  • "levelOfEmployment": 0,
  • "intervals": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}

voucher

Create a voucher

path Parameters
companyId
required
string <uuid>

The company UUID.

Request Body schema: application/json
required
serie
required
string
description
required
string
comments
required
string
date
required
string <date>

Transaction date (YYYY-MM-DD)

required
Array of objects (Accounting_REST_API_Api-voucher-transaction)
required
Array of objects (Accounting_REST_API_Api-voucher-file)

Responses

Request samples

Content type
application/json
{
  • "serie": "string",
  • "description": "string",
  • "comments": "string",
  • "date": "2019-08-24",
  • "transactions": [
    ],
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}

dimension

Get dimensions

path Parameters
companyId
required
string <uuid>

The company UUID.

query Parameters
cursor
string <uuid>

Page token from a previous response's pagination.nextCursor. Omit for the first page.

limit
integer <int32>

Maximum number of dimensions to return on this page.

createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

order
string (Accounting_REST_API_Order)
Default: "asc"
Enum: "asc" "desc"

Sort direction by the resource id cursor (UUIDv7). Defaults to asc (oldest-first).

Responses

Response samples

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

Get dimension entries

path Parameters
companyId
required
string <uuid>

The company UUID.

dimensionId
required
string <uuid>
query Parameters
cursor
string <uuid>

Page token from a previous response's pagination.nextCursor. Omit for the first page.

limit
integer <int32>

Maximum number of dimension entries to return on this page.

createdAfter
string <date-time>

Return only resources created at or after this instant (createdAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset, e.g. 2026-05-29T14:30:00Z or 2026-05-29T14:30:00+02:00.

createdBefore
string <date-time>

Return only resources created before this instant (createdAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedAfter
string <date-time>

Return only resources updated at or after this instant (updatedAt >= value). RFC 3339 / ISO-8601 date-time with timezone offset.

updatedBefore
string <date-time>

Return only resources updated before this instant (updatedAt < value). RFC 3339 / ISO-8601 date-time with timezone offset.

order
string (Accounting_REST_API_Order)
Default: "asc"
Enum: "asc" "desc"

Sort direction by the resource id cursor (UUIDv7). Defaults to asc (oldest-first).

Responses

Response samples

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

Add an entry to a dimension

path Parameters
companyId
required
string <uuid>

The company UUID.

dimensionId
required
string <uuid>
Request Body schema: application/json
required
name
required
string
foreign-id
string
description
required
string
start-date
string <date>
end-date
string <date>
active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "foreign-id": "string",
  • "description": "string",
  • "start-date": "2019-08-24",
  • "end-date": "2019-08-24",
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Update a dimension entry by id

path Parameters
companyId
required
string <uuid>

The company UUID.

dimensionId
required
string <uuid>
entryId
required
string <uuid>
Request Body schema: application/json
required
name
required
string
foreign-id
string
description
required
string
start-date
string <date>
end-date
string <date>
active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "foreign-id": "string",
  • "description": "string",
  • "start-date": "2019-08-24",
  • "end-date": "2019-08-24",
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

exchangerate

Get the latest exchange rate from one currency to another

query Parameters
from
required
string
to
required
string

Responses

Response samples

Content type
application/json
{
  • "fromCurrency": "string",
  • "toCurrency": "string",
  • "rate": "string"
}