Toggle expense completion for a transaction

PATCH 
/api/transactions/:id/toggle-expense-completed

This endpoint marks a transaction expenses as completed or not complete.

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:

• markAsComplete: Boolean flag to set expense as complete or put back in not completed.

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

• transaction.type.not_supported
• input.mark_as_complete.not_valid
• invalid

Request

Path Parameters

id stringrequired

Transaction identifier

application/json

Body

required

markAsComplete booleannull

Responses

200

OK - The request was processed successfully.

application/json

Schema

Schema

id integer
currency string
amount string
type string

Possible values: [fee, payin, payout, peer, fx, card]

executionDate string
executed boolean
createdAt string
updatedAt string
account integer
transactionDetailId integernull
tags string[]
documents object
id integer
name string
mimeType string
expenseCategory object
id integer
name string
accountingAccountNumber string
externalId string
expenseCostCenter object
id integer
name string
number string
vat string[]deprecated
vats object[]
Array [
expenseVat stringnull
rate string
amount string
grossAmount string
externalId stringnull
]
comment stringnull
expenseCompletedAt stringnull
magicLinkUrl stringnull
contact object
id integer

Example (from schema)

{
  "id": "1",
  "currency": "CHF",
  "amount": "100.00",
  "type": "payin",
  "executionDate": "2023-01-01T00:00:00+00:00",
  "executed": true,
  "createdAt": "2023-01-01T00:00:00+00:00",
  "updatedAt": "2023-01-01T00:00:00+00:00",
  "account": 1,
  "transactionDetailId": 1,
  "tags": [
    "tag1",
    "tag2"
  ],
  "documents": {
    "id": "1",
    "name": "example_document.jpg",
    "mimeType": "image/jpeg"
  },
  "expenseCategory": {
    "id": "1",
    "name": "Travel expense",
    "accountingAccountNumber": "123456",
    "externalId": "abcefg"
  },
  "expenseCostCenter": {
    "id": "1",
    "name": "Travel expense",
    "number": "123456"
  },
  "vats": [
    {
      "expenseVat": "/api/expense_vats/1",
      "rate": "5",
      "amount": "20",
      "grossAmount": "120",
      "externalId": "vat-5"
    }
  ],
  "expenseCompletedAt": "2023-01-01T00:00:00+00:00",
  "magicLinkUrl": "https://app.amnis.com/expenses-public/4cb001f8-2b57-4b4a-8d2c-7d1a2f3b4c5d",
  "contact": {
    "id": "1"
  }
}

400

Bad Request -- Your request is invalid.

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.

404

Not Found -- The requested resource could not be found.

422

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

Loading...