Update expense information for a transaction

PATCH 
/api/transactions/:id/expense

This endpoint updates expense information for an existing transaction.

Prerequisites:

To use this endpoint you need to have the ACCOUNTING scope for the API Key. Please contact your relation manager to get this permission.

Eligibility: The transaction type must be enabled in the business partner expense settings targets.

Request Body:

• category: Expense category IRI.
• costCenter: Expense cost center IRI.
• vats: Array of 1-3 VAT rows containing expenseVat, rate, amount, grossAmount, externalId.
• vatRate/vatAmount: Deprecated legacy format, still accepted for backward compatibility.
• note: Optional comment.

Completion update: Expense completion is recalculated during the request, and the response contains the latest expenseCompletedAt value.

Validation Errors: Responses return status 422 with an errors array containing field, code, and message. Possible code values include:

• transaction.type.not_supported
• input.category.not_valid
• input.cost_center.not_valid
• input.vat_rate.not_valid
• input.vat_amount.not_valid
• input.comment.not_valid
• expense.vat.not_valid
• expense.category.transaction_type_not_allowed
• expense.cost_center.transaction_type_not_allowed
• expense.category.card_group_not_allowed
• expense.cost_center.card_group_not_allowed
• invalid

Request

Path Parameters

id stringrequired

Transaction identifier

application/json

Body

required

category stringnull
costCenter stringnull
vatRate string[]
vatAmount string[]
vats object[]
Array [
expenseVat stringnull
rate string
amount stringnull
grossAmount string
externalId stringnull
]
note stringnull

Responses

401

Unauthorised -- Your access token is wrong.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

403

Forbidden -- Access to the requested resource or action is forbidden.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

422

Unprocessable Content -- We could not process your request due to invalid data provided.

application/json

Schema

Schema

status integer
message string
errors object[]
Array [
field string
code string
message string
]

Example (from schema)

{
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "category",
      "code": "input.category.not_valid",
      "message": "Category is not valid."
    }
  ]
}

Example

{
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "category",
      "code": "input.category.not_valid",
      "message": "Category is not valid."
    },
    {
      "field": "vatRate",
      "code": "input.vat_rate.not_valid",
      "message": "VAT rate must be an array of 1-3 numeric values."
    }
  ]
}

Loading...