Visma.net ERP API

{
  "openapi": "3.0.4",
  "info": {
    "title": "Visma.net ERP API",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.finance.visma.net"
    }
  ],
  "paths": {
    "/v1/account/{accountCd}": {
      "get": {
        "tags": [
          "Account"
        ],
        "summary": "Get a specific Account - ScreenId=GL202500",
        "description": "Data for Account<br></br>\r\n            The response headers include an ETag after a successful GET operation.",
        "operationId": "Account_GetByaccountCd",
        "parameters": [
          {
            "name": "accountCd",
            "in": "path",
            "description": "Return the Information from Chart of account for the specified AccountCD",
            "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.\r\nSupported values:\r\n* 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.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"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.\r\nOptionally 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.\r\n\r\nTo 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/AccountDto"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountDto"
                }
              }
            }
          },
          "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": [
          {
            "serviceapi": [ ]
          }
        ]
      },
      "put": {
        "tags": [
          "Account"
        ],
        "summary": "Updates an account",
        "description": "Response Message has StatusCode NoContent if PUT operation succeed<br></br>\r\n            Response Message has StatusCode BadRequest if PUT operation failed<br></br>\r\n            The response headers include an ETag after a successful PUT operation",
        "operationId": "Account_PutByaccountCd",
        "parameters": [
          {
            "name": "accountCd",
            "in": "path",
            "description": "Identifies the account 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.\r\nSupported values:\r\n* 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.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"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.\r\nOptionally 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.\r\n\r\nTo 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\r\n* 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 fields and field values to be updated",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            },
            "text/xml": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            }
          },
          "required": true,
          "x-bodyName": "accountUpdateDto"
        },
        "responses": {
          "204": {
            "description": "NoContent",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              },
              "text/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "412": {
            "description": "Account 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": [
          {
            "serviceapi": [ ]
          }
        ]
      }
    },
    "/v1/account": {
      "get": {
        "tags": [
          "Account"
        ],
        "summary": "Get a range of General ledger accounts - ScreenId=GL202500",
        "description": "Data for Account",
        "operationId": "Account_GetAll",
        "parameters": [
          {
            "name": "active",
            "in": "query",
            "description": "Set to True to select active accounts.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "includeAccountClassDescription",
            "in": "query",
            "description": "Set to True to include AccountClass description.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "greaterThanValue",
            "in": "query",
            "description": "Enter the from-value for Account no.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "publicCode",
            "in": "query",
            "description": "Filter by the Public code 1, authorities mapped code to the account.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "externalCode1",
            "in": "query",
            "description": "Filter by External code 1 (field used for sorting and inquiries.)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "externalCode2",
            "in": "query",
            "description": "Filter by External code 2 (field used for sorting and inquiries.)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "analysisCode",
            "in": "query",
            "description": "Filter by Analysis code (field used for sorting and inquiries.)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "numberToRead",
            "in": "query",
            "description": "This field has been deprecated and will be removed in future versions.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "skipRecords",
            "in": "query",
            "description": "This field has been deprecated and will be removed in future versions.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "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.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_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.\r\n\r\nAccepted values (without the single quotes):\r\n* '&gt;' for greater than\r\n* '&lt;' for less than\r\n* '&gt;=' for greater than or equal\r\n* '&lt;=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.",
            "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.\r\nSupported values:\r\n* 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.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"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.\r\nOptionally 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.\r\n\r\nTo 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/AccountDto"
                  }
                }
              },
              "text/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AccountDto"
                  }
                }
              }
            }
          },
          "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": [
          {
            "serviceapi": [ ]
          }
        ]
      },
      "post": {
        "tags": [
          "Account"
        ],
        "summary": "Creates an account",
        "description": "Response Message has StatusCode Created if POST operation succeed<br></br>\r\n            The response headers include an ETag after a successful POST operation.<br></br>\r\n            Response Message has StatusCode BadRequest or InternalServerError if POST operation failed",
        "operationId": "Account_Post",
        "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.\r\nSupported values:\r\n* 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.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"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.\r\nOptionally 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.\r\n\r\nTo 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 fields and field values to be set on created account",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            },
            "text/xml": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/AccountUpdateDto"
              }
            }
          },
          "required": true,
          "x-bodyName": "accountUpdateDto"
        },
        "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": [
          {
            "serviceapi": [ ]
          }
        ]
      }
    },
    "/v1/attachment/{attachmentId}": {
      "get": {
        "tags": [
          "Attachment"
        ],
        "summary": "Get latest revision of a specific Attachment",
        "operationId": "Attachment_GetByattachmentId",
        "parameters": [
          {
            "name": "attachmentId",
            "in": "path",
            "description": "Identifies the attachment",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "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.\r\nSupported values:\r\n* 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.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"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.\r\nOptionally 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.\r\n\r\nTo 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": "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": [
          {
            "serviceapi": [ ]
          }
        ]
      },
      "put": {
        "tags": [
          "Attachment"
        ],
        "summary": "Update a specific Attachment",
        "description": "The the Response Message has StatusCode NoContent if Put operation succeed",
        "operationId": "Attachment_PutByattachmentId",
        "parameters": [
          {
            "name": "attachmentId",
            "in": "path",
            "description": "Identifies the Attachment to update",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "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.\r\nSupported values:\r\n* 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.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"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.\r\nOptionally 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.\r\n\r\nTo 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 Attachment to update",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttachmentMetadataUpdateDto"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/AttachmentMetadataUpdateDto"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/AttachmentMetadataUpdateDto"
              }
            },
            "text/xml": {
              "schema": {
                "$ref": "#/components/schemas/AttachmentMetadataUpdateDto"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/AttachmentMetadataUpdateDto"
              }
            }
          },
          "required": true,
          "x-bodyName": "metadataDto"
        },
        "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": [
          {
            "serviceapi": [ ]
          }
        ]
      }
    },
    "/v1/attribute/{attributeId}": {
      "get": {
        "tags": [
          "Attribute"
        ],
        "summary": "Get specific Attribute",
        "operationId": "Attribute_GetAttributeByattributeId",
        "parameters": [
          {
            "name": "attributeId",
            "in": "path",
            "description": "Identifies the attribute",
            "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.\r\nSupported values:\r\n* 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.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"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.\r\nOptionally 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.\r\n\r\nTo 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/AttributeDto"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttributeDto"
                }
              }
            }
          },
          "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": [
          {
            "serviceapi": [ ]
          }
        ]
      },
      "put": {
        "tags": [
          "Attribute"
        ],
        "summary": "Updates an attribute",
        "description": "Response Message has StatusCode NoContent if PUT operation succeed",
        "operationId": "Attribute_PutByattributeId",
        "parameters": [
          {
            "name": "attributeId",
            "in": "path",
            "description": "Identifies the attribute 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.\r\nSupported values:\r\n* 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.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"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.\r\nOptionally 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.\r\n\r\nTo 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 fields and field values to be updated",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeUpdateDto"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeUpdateDto"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/AttributeUpdateDto"
              }
            },
            "text/xml": {
              "schema": {
                "$ref": "#/components/schemas/AttributeUpdateDto"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/AttributeUpdateDto"
              }
            }
          },
          "required": true,
          "x-bodyName": "attributeUpdateDto"
        },
        "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": [
          {
            "serviceapi": [ ]
          }
        ]
      },
      "delete": {
        "tags": [
          "Attribute"
        ],
        "summary": "Deletes an attribute",
        "description": "Response Message has StatusCode NoContent if DEL operation succeed",
        "operationId": "Attribute_DeleteByattributeId",
        "parameters": [
          {
            "name": "attributeId",
            "in": "path",
            "description": "Identifies the attribute 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.\r\nSupported values:\r\n* 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.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscr

# --- truncated at 32 KB (4217 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visma/refs/heads/main/openapi/visma-net-erp-service-api-openapi.json