Create an expense category
POST/api/expense_categories
This endpoint is intended to create a new expense category.
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.
Request Body:
- name: The name of the category. Multiple categories with the same name cannot be added.
- accountingAccountNumber: Optional.
- externalId: Optional. The identifier in the external accounting program. Multiple categories with the same name cannot be added.
- allowedTransactionTypes: Optional. Defines which type of transactions can be attached to this category. Multiple choices can be added.
- allowedCardGroups: Optional. Defines which card groups can be attached to this category. Multiple choices can be added.
Request
Header Parameters
Possible values: <= 50 characters
An optional unique identifier for the request, limited to 50 characters. Used to track requests and prevent duplication.
- application/json
Body
required
Possible values: [card_transaction, fee_transaction, fx_transaction, payin_transaction, payout_transaction, wallet_transaction]
Responses
- 200
- 201
- 400
- 401
- 403
- 422
OK - The request was processed successfully.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [card_transaction, fee_transaction, fx_transaction, payin_transaction, payout_transaction, wallet_transaction]
{
"id": 0,
"name": "Travels",
"accountingAccountNumber": "123132",
"externalId": "123132",
"allowedTransactionTypes": [
"fee_transaction",
"fx_transaction"
],
"allowedCardGroups": [
"2",
"7"
]
}
Created - The request was processed successfully.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [card_transaction, fee_transaction, fx_transaction, payin_transaction, payout_transaction, wallet_transaction]
{
"id": 0,
"name": "Travels",
"accountingAccountNumber": "123132",
"externalId": "123132",
"allowedTransactionTypes": [
"fee_transaction",
"fx_transaction"
],
"allowedCardGroups": [
"2",
"7"
]
}
Bad Request -- Your request is invalid.
- application/json
- Schema
- Example (from schema)
Schema
{
"title": "string",
"type": "string",
"detail": "string"
}
Unauthorised -- Your access token is wrong.
- application/json
- Schema
- Example (from schema)
Schema
{
"type": "string",
"title": "string",
"detail": "string"
}
Forbidden -- Access to the requested resource or action is forbidden.
- application/json
- Schema
- Example (from schema)
Schema
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
Default value: 400
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
{
"title": "string",
"detail": "string",
"status": 400,
"instance": "string",
"type": "string"
}
Unprocessable Content -- We could not process your request due to invalid data provided.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
Default value: 422
violations object[]
The property path of the violation
The message associated with the violation
The code of the violation
An extra hint to understand the violation
payload object
The serialized payload of the violation
The serialized payload of the violation
{
"status": 422,
"violations": [
{
"propertyPath": "string",
"message": "string",
"code": "string",
"hint": "string",
"payload": {}
}
],
"detail": "string",
"type": "string",
"title": "string",
"instance": "string"
}