Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Visma.net ERP Expense Claim API
version: v1
servers:
- url: https://api.finance.visma.net
tags:
- name: ExpenseClaim
paths:
/v1/expenseClaim/{expenseClaimNbr}:
get:
tags:
- ExpenseClaim
summary: Get a specific Expense Claim
description: 'Data for a single expense claim
The response headers include an ETag after a successful GET operation.'
operationId: ExpenseClaim_GetExpenseClaimByexpenseClaimNbr
parameters:
- name: expenseClaimNbr
in: path
description: Identifies the expense claim
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExpenseClaimDto'
text/json:
schema:
$ref: '#/components/schemas/ExpenseClaimDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
put:
tags:
- ExpenseClaim
summary: Update a specific ExpenseClaim
description: 'Response Message has StatusCode NoContent if PUT operation succeed.
Response Message has StatusCode BadRequest if PUT operation failed.
The response headers include an ETag after a successful PUT operation.'
operationId: ExpenseClaim_PutByexpenseClaimNbr
parameters:
- name: expenseClaimNbr
in: path
description: Identifies the ExpenseClaim to update
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
- name: If-Match
in: header
description: 'The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.
The If-Match header should be included in the request headers using the following syntax: If-Match: "etag_value"
* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.
* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.'
schema:
type: string
requestBody:
description: Defines the data for the ExpenseClaim to update
content:
application/json:
schema:
$ref: '#/components/schemas/ExpenseClaimUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/ExpenseClaimUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ExpenseClaimUpdateDto'
required: true
x-bodyName: expenseClaim
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'412':
description: Expense Claim version does not match with If-Match header
content:
application/json: {}
text/json: {}
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
delete:
tags:
- ExpenseClaim
summary: Deletes a specific ExpenseClaim
description: Response Message has StatusCode NoContent if DELETE operation succeed
operationId: ExpenseClaim_DeleteByexpenseClaimNbr
parameters:
- name: expenseClaimNbr
in: path
description: Identifies the ExpenseClaim to delete
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
responses:
'204':
description: NoContent
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
/v1/expenseClaim:
get:
tags:
- ExpenseClaim
summary: Get a range of Expense Claims, a filter needs to be specified.
operationId: ExpenseClaim_GetAll
parameters:
- name: status
in: query
description: The status of the document.
schema:
enum:
- Hold
- PendingApproval
- Approved
- Rejected
- Released
type: string
- name: date
in: query
description: The date of the document
schema:
type: string
format: date-time
- name: customer
in: query
description: The customer from the document
schema:
type: string
- name: departmentId
in: query
description: Identifies the department
schema:
type: string
- name: greaterThanValue
in: query
description: Greater-than value. The item which is the object for this, varies from API to API.
schema:
type: string
- name: numberToRead
in: query
description: This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
schema:
type: integer
format: int32
- name: skipRecords
in: query
description: This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
schema:
type: integer
format: int32
- name: orderBy
in: query
description: This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.
schema:
type: string
- name: lastModifiedDateTime
in: query
description: 'This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.
Accepted format:
* ```yyyy-MM-dd```
* ```yyyy-MM-dd HH:mm:ss```
* ```yyyy-MM-dd HH:mm:ss.FFF```
* ```yyyy-MM-ddTHH:mm:ss```
* ```yyyy-MM-ddTHH:mm:ss.FFF```
_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.'
schema:
type: string
- name: lastModifiedDateTimeCondition
in: query
description: 'This value represents the condition to be applied when retrieving records.
Accepted values (without the single quotes):
* ''>'' for greater than
* ''<'' for less than
* ''>='' for greater than or equal
* ''<='' for less than or equal
_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.'
schema:
type: string
- name: pageNumber
in: query
description: Pagination parameter. Page number.
schema:
type: integer
format: int32
- name: pageSize
in: query
description: 'Pagination parameter. Number of items to be collected.
Please use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.
If requested page size is greater than allowed max page size, request will be limited to max page size.'
schema:
type: integer
format: int32
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExpenseClaimDto'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExpenseClaimDto'
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
post:
tags:
- ExpenseClaim
summary: Create an ExpenseClaim
description: 'Response Message has StatusCode Created if POST operation succeed.
Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.
The response headers include an ETag after a successful POST operation.'
operationId: ExpenseClaim_CreateExpenseClaim
parameters:
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
requestBody:
description: Defines the data for the ExpenseClaim to create
content:
application/json:
schema:
$ref: '#/components/schemas/ExpenseClaimUpdateDto'
text/json:
schema:
$ref: '#/components/schemas/ExpenseClaimUpdateDto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ExpenseClaimUpdateDto'
required: true
x-bodyName: expenseClaim
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
/v1/expenseClaim/{expenseClaim}/action/hold:
post:
tags:
- ExpenseClaim
summary: Put ExpenseClaim on hold
description: 'The action result dto contains information about the result of running the action.
Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.
In this endpoint, If-Match can also be checked against resource current version when calling with ''erp-api-background'' HTTP header.'
operationId: ExpenseClaim_PutExpenseClaimOnHoldByexpenseClaim
parameters:
- name: expenseClaim
in: path
description: Reference number of the ExpenseClaim to be put on hold
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
- name: If-Match
in: header
description: 'The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.
The If-Match header should be included in the request headers using the following syntax: If-Match: "etag_value"
* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.
* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PutExpenseClaimOnHoldActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/PutExpenseClaimOnHoldActionResultDto'
application/xml:
schema:
$ref: '#/components/schemas/PutExpenseClaimOnHoldActionResultDto'
text/xml:
schema:
$ref: '#/components/schemas/PutExpenseClaimOnHoldActionResultDto'
'412':
description: Expense Claim version does not match with If-Match header
content:
application/json: {}
text/json: {}
application/xml: {}
text/xml: {}
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
application/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
/v1/expenseClaim/{expenseClaim}/action/submit:
post:
tags:
- ExpenseClaim
summary: Submit Expense Claim operation
description: 'The action result dto contains information about the result of running the action.
Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.
In this endpoint, If-Match can also be checked against resource current version when calling with ''erp-api-background'' HTTP header.'
operationId: ExpenseClaim_SubmitExpenseClaimByexpenseClaim
parameters:
- name: expenseClaim
in: path
description: Reference number of the Expense Claim to be submitted
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
- name: If-Match
in: header
description: 'The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.
The If-Match header should be included in the request headers using the following syntax: If-Match: "etag_value"
* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.
* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitExpenseClaimActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/SubmitExpenseClaimActionResultDto'
application/xml:
schema:
$ref: '#/components/schemas/SubmitExpenseClaimActionResultDto'
text/xml:
schema:
$ref: '#/components/schemas/SubmitExpenseClaimActionResultDto'
'412':
description: Expense Claim version does not match with If-Match header
content:
application/json: {}
text/json: {}
application/xml: {}
text/xml: {}
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
application/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
/v1/expenseClaim/{expenseClaim}/action/approval:
post:
tags:
- ExpenseClaim
summary: Send Expense Claim to approval
description: 'The action result dto contains information about the result of running the action.
Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.
In this endpoint, If-Match can also be checked against resource current version when calling with ''erp-api-background'' HTTP header.'
operationId: ExpenseClaim_SendExpenseClaimToApprovalByexpenseClaim
parameters:
- name: expenseClaim
in: path
description: Reference number of the Expense Claim to be sent to approval
required: true
schema:
type: string
- name: erp-api-background
in: header
description: 'Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.
Supported values:
* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.
* "none" (without quotes): Fire and forget; no notification will be sent when background operation is finished.
* "subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.
Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription''s url.
To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content'
schema:
type: string
- name: If-Match
in: header
description: 'The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.
The If-Match header should be included in the request headers using the following syntax: If-Match: "etag_value"
* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.
* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SendExpenseClaimToApprovalActionResultDto'
text/json:
schema:
$ref: '#/components/schemas/SendExpenseClaimToApprovalActionResultDto'
application/xml:
schema:
$ref: '#/components/schemas/SendExpenseClaimToApprovalActionResultDto'
text/xml:
schema:
$ref: '#/components/schemas/SendExpenseClaimToApprovalActionResultDto'
'412':
description: Expense Claim version does not match with If-Match header
content:
application/json: {}
text/json: {}
application/xml: {}
text/xml: {}
'202':
description: Server accepted and queued the request for background execution.
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/json:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
application/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
text/xml:
schema:
$ref: '#/components/schemas/BackgroundApiAcceptedDto'
security:
- interactiveapi: []
components:
schemas:
projectInExpenseClaimDetailUpdateDto:
properties:
value:
type: string
description: The project or customer contract associated with the expense claim, if the work performed was for a project or contract. Project Task The task associated with the contract or project.
BackgroundApiAcceptedDto:
type: object
properties:
id:
type: string
stateLocation:
type: string
PutExpenseClaimOnHoldActionResultDto:
type: object
properties:
actionId:
type: string
format: uuid
actionResult:
enum:
- Queued
- InProcess
- Failed
- Done
type: string
errorInfo:
type: string
quantityInExpenseClaimDetailUpdateDto:
properties:
value:
type: number
format: double
description: The quantity of this expense item.
AttachmentDto:
type: object
properties:
name:
type: string
description: The name of the attachment.
id:
type: string
description: The ID of the attachment
format: uuid
example: 00000000-0000-0000-0000-000000000000
revision:
type: integer
description: The version of the attachment.
format: int32
customerInExpenseClaimDetailUpdateDto:
properties:
value:
type: string
description: The identifier of the customer associated with the expense.
SegmentUpdateDto:
type: object
properties:
segmentId:
type: integer
format: int32
segmentValue:
type: string
dateInExpenseClaimUpdateDto:
properties:
value:
type: string
format: date-time
description: The date when the claim was entered.
customerInExpenseClaimDetailDto:
properties:
number:
type: string
name:
type: string
description: Click the magnifier. > The name.
description: Customer > The identifier of the customer associated with the expense.
SendExpenseClaimToApprovalActionResultDto:
type: object
properties:
actionId:
type: string
format: uuid
actionResult:
enum:
- Queued
- InProcess
- Failed
- Done
type: string
errorInfo:
type: string
descriptionInExpenseClaimUpdateDto:
properties:
value:
type: string
description: A description of the claim.
projectTaskInExpenseClaimDetailUpdateDto:
properties:
value:
type: string
description: The task associated with the contract or project.
descriptionInExpenseClaimDetailU
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-expenseclaim-api-openapi.yml