Skip to main content

Expense information

Amnis expense API docs is here to help you integrate with amnis API.

📄️ Create an expense category

<p>This endpoint is intended to create a new expense category.</p> <p><b>Prerequisites:</b></p> <p>To use this endpoint you need to have the <b>ACCOUNTING</b> scope for the API Key. Please contact your relation manager to get this permission.</p> <p><b>Request Body:</b></p> <ul> <li><b>name</b>: The name of the category. Multiple categories with the same name cannot be added.</li> <li><b>accountingAccountNumber</b>: Optional.</li> <li><b>externalId</b>: Optional. The identifier in the external accounting program. Multiple categories with the same name cannot be added.</li><li><b>allowedTransactionTypes</b>: Optional. Defines which type of transactions can be attached to this category. Multiple choices can be added.</li><li><b>allowedCardGroups</b>: Optional. Defines which card groups can be attached to this category. Multiple choices can be added.</li></ul>

📄️ Create an expense cost center

<p>This endpoint is intended to create a new expense cost center.</p> <p><b>Prerequisites:</b></p> <p>To use this endpoint you need to have the <b>ACCOUNTING</b> scope for the API Key. Please contact your relation manager to get this permission.</p> <p><b>Request Body:</b></p> <ul> <li><b>name</b>: The name of the cost center. Multiple cost centers with the same name and number combination cannot be added.</li> <li><b>number</b>: Optional.</li><li><b>allowedTransactionTypes</b>: Optional. Defines which type of transactions can be attached to this category. Multiple choices can be added.</li><li><b>allowedCardGroups</b>: Optional. Defines which card groups can be attached to this category. Multiple choices can be added.</li></ul>

📄️ Create an expense VAT

<p>This endpoint is intended to create a new expense VAT.</p> <p><b>Prerequisites:</b></p> <p>To use this endpoint you need to have the <b>ACCOUNTING</b> scope for the API Key. Please contact your relation manager to get this permission.</p> <p><b>Request Body:</b></p> <ul> <li><b>name</b>: The name of the VAT. Multiple VATs with the same name cannot be added.</li> <li><b>value</b>: Required.</li><li><b>externalId</b>: Optional.</li><li><b>importTax</b>: Optional.</li></ul>

📄️ Toggle expense completion for a transaction

<p>This endpoint is intended to mark a card transaction expense as completed or reset it to draft.</p> <p><b>Prerequisites:</b></p> <p>To use this endpoint you need to have the <b>ACCOUNTING</b> scope for the API Key. Please contact your relation manager to get this permission.</p> <p><b>Request Body:</b></p> <ul> <li><b>markAsComplete</b>: Boolean flag to set expense completion.</li></ul> <p><b>Validation Errors:</b> Responses return status <b>422</b> with an <b>errors</b> array containing <b>field</b>, <b>code</b>, and <b>message</b>. Possible <b>code</b> values include:</p> <ul> <li><b>transaction.type.not_supported</b></li> <li><b>input.mark_as_complete.not_valid</b></li> <li><b>expense.category.required</b></li> <li><b>expense.cost_center.required</b></li> <li><b>expense.vat.required</b></li> <li><b>expense.receipt.required</b></li> <li><b>expense.vat.not_valid</b></li> <li><b>invalid</b></li></ul>

📄️ Update expense information for a transaction

<p>This endpoint is intended to update expense information for an existing card transaction.</p> <p><b>Prerequisites:</b></p> <p>To use this endpoint you need to have the <b>ACCOUNTING</b> scope for the API Key. Please contact your relation manager to get this permission.</p> <p><b>Request Body:</b></p> <ul> <li><b>category</b>: Expense category IRI.</li> <li><b>costCenter</b>: Expense cost center IRI.</li> <li><b>vatRate</b>: Array of 1-3 VAT rates.</li> <li><b>vatAmount</b>: Array of 1-3 VAT gross amounts.</li> <li><b>note</b>: Optional comment.</li></ul> <p><b>Async Notice:</b> Expense completion is calculated asynchronously. The <b>expenseCompletedAt</b> value in the response may reflect the last stored state and update shortly after processing.</p> <p><b>Validation Errors:</b> Responses return status <b>422</b> with an <b>errors</b> array containing <b>field</b>, <b>code</b>, and <b>message</b>. Possible <b>code</b> values include:</p> <ul> <li><b>transaction.type.not_supported</b></li> <li><b>input.category.not_valid</b></li> <li><b>input.cost_center.not_valid</b></li> <li><b>input.vat_rate.not_valid</b></li> <li><b>input.vat_amount.not_valid</b></li> <li><b>input.comment.not_valid</b></li> <li><b>expense.vat.not_valid</b></li> <li><b>expense.category.transaction_type_not_allowed</b></li> <li><b>expense.cost_center.transaction_type_not_allowed</b></li> <li><b>expense.category.card_group_not_allowed</b></li> <li><b>expense.cost_center.card_group_not_allowed</b></li> <li><b>invalid</b></li></ul>