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:
Validation Errors: Responses return status 422 with an errors array containing field, code, and message. Possible code values include:
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:
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:
This endpoint is intended to create a new payment.
Prerequisites:
To use this endpoint you need to have the PAYMENT_CREATE scope for the API Key. Please contact your relation manager to get this permission.
Request Parameters:
Beneficiary Object is represented as Contact Object.
Payment signoff
This API endpoint is tailored to retrieve detailed information about an individual expense VAT, serving as a valuable tool for accessing specific expense VAT data within your system.
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.
", "parameters": [ { "name": "id", "in": "path", "description": "Expense VAT identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "security": [ { "bearerAuth": [ "ACCOUNTING" ] } ] } }, "/api/expense_vats": { "get": { "operationId": "get-expense-vat-list", "tags": [ "Expense VAT" ], "responses": { "200": { "description": "OK - The request was processed successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Expense.VAT-ExpenseVATView" } } } } }, "403": { "description": "Forbidden -- Access to the requested resource or action is forbidden." }, "401": { "description": "Unauthorised -- Your access token is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationFailed" } } } } }, "summary": "Retrieve a collection of expense VAT rates", "description": "This API endpoint is designed to retrieve a collection of expense VAT rates, providing a valuable tool for accessing recent expense VAT rates data for an account within your system.
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.
", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 50 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "pagination", "in": "query", "description": "Enable or disable pagination", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "security": [ { "bearerAuth": [ "ACCOUNTING" ] } ] }, "post": { "operationId": "create-expense-vat", "tags": [ "Expense VAT" ], "responses": { "200": { "description": "OK - The request was processed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseVAT-ExpenseVATView" } } } }, "400": { "description": "Bad Request -- Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "401": { "description": "Unauthorised -- Your access token is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationFailed" } } } }, "403": { "description": "Forbidden -- Access to the requested resource or action is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessDenied" } } } } }, "summary": "Create an expense VAT", "description": "This endpoint is intended to create a new expense VAT.
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:
This API endpoint is tailored to retrieve detailed information about an individual expense cost center, serving as a valuable tool for accessing specific expense cost center data within your system.
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.
", "parameters": [ { "name": "id", "in": "path", "description": "ExpenseCostCenter identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "security": [ { "bearerAuth": [ "ACCOUNTING" ] } ] } }, "/api/expense_cost_centers": { "get": { "operationId": "get-expense-cost-center-list", "tags": [ "ExpenseCostCenter" ], "responses": { "200": { "description": "OK - The request was processed successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseCostCenter-ExpenseCostCenterView" } } } } }, "403": { "description": "Forbidden -- Access to the requested resource or action is forbidden." }, "401": { "description": "Unauthorised -- Your access token is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationFailed" } } } } }, "summary": "Retrieve a collection of expense cost centers", "description": "This API endpoint is designed to retrieve a collection of expense cost centers, providing a valuable tool for accessing recent expense cost center data for an account within your system.
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.
", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 50 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "pagination", "in": "query", "description": "Enable or disable pagination", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "security": [ { "bearerAuth": [ "ACCOUNTING" ] } ] }, "post": { "operationId": "create-expense-cost-center", "tags": [ "ExpenseCostCenter" ], "responses": { "200": { "description": "OK - The request was processed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseCostCenter-ExpenseCostCenterView" } } } }, "400": { "description": "Bad Request -- Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "401": { "description": "Unauthorised -- Your access token is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationFailed" } } } }, "403": { "description": "Forbidden -- Access to the requested resource or action is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessDenied" } } } } }, "summary": "Create an expense cost center", "description": "This endpoint is intended to create a new expense cost center.
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:
This API endpoint is tailored to retrieve detailed information about an individual expense category, serving as a valuable tool for accessing specific expense category data within your system.
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.
", "parameters": [ { "name": "id", "in": "path", "description": "ExpenseCategory identifier", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false } ], "deprecated": false, "security": [ { "bearerAuth": [ "ACCOUNTING" ] } ] } }, "/api/expense_categories": { "get": { "operationId": "get-expense-category-list", "tags": [ "ExpenseCategory" ], "responses": { "200": { "description": "OK - The request was processed successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseCategory-ExpenseCategoryView" } } } } }, "403": { "description": "Forbidden -- Access to the requested resource or action is forbidden." }, "401": { "description": "Unauthorised -- Your access token is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationFailed" } } } } }, "summary": "Retrieve a collection of expense categories", "description": "This API endpoint is designed to retrieve a collection of expense categories, providing a valuable tool for accessing recent expense category data for an account within your system.
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.
", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 50 }, "style": "form", "explode": false, "allowReserved": false }, { "name": "pagination", "in": "query", "description": "Enable or disable pagination", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false } ], "deprecated": false, "security": [ { "bearerAuth": [ "ACCOUNTING" ] } ] }, "post": { "operationId": "create-expense-category", "tags": [ "ExpenseCategory" ], "responses": { "200": { "description": "OK - The request was processed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseCategory-ExpenseCategoryView" } } } }, "400": { "description": "Bad Request -- Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestException" } } } }, "401": { "description": "Unauthorised -- Your access token is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationFailed" } } } }, "403": { "description": "Forbidden -- Access to the requested resource or action is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessDenied" } } } } }, "summary": "Create an expense category", "description": "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:
true if want to ship to business partner address. false if want to send to custom address."
},
"shippingAddress": {
"type": "string",
"example": "Broadway 1",
"description": "If **shipToBusinessPartnerAddress**=false use this field for the Street and Street Number of the custom address."
},
"shippingCity": {
"type": "string",
"example": "London",
"description": "If **shipToBusinessPartnerAddress**=false use this field for City of the custom address."
},
"shippingCountry": {
"description": "ISO 3166-1 alpha-2 country code. If **shipToBusinessPartnerAddress**=false use this field for Country of the custom address.",
"type": "string",
"example": "DE"
},
"shippingZip": {
"type": "string",
"example": "11000",
"description": "If **shipToBusinessPartnerAddress**=false use this field for the Zip Code of the custom address."
},
"shippingStateOrProvince": {
"type": "string",
"example": "TX",
"description": "If **shipToBusinessPartnerAddress**=false use this field for the US State of the custom address. Used just for US."
}
}
},
"CardHolder-CardHolderEdit": {
"type": "object",
"description": "",
"deprecated": false,
"required": [
"phoneNumber"
],
"properties": {
"phoneNumber": {
"minLength": 2,
"maxLength": 255,
"type": "string",
"example": "+4593872813",
"description": "E164 format phone number"
}
}
},
"CardHolder-CardHolderView": {
"type": "object",
"description": "Retrieves card information",
"deprecated": false,
"properties": {
"id": {
"type": "integer"
},
"firstName": {
"type": [
"string",
"null"
]
},
"lastName": {
"type": [
"string",
"null"
]
},
"embossedName": {
"type": "string",
"description": "The name to be embossed on the card. It must follow the regex pattern `/^[A-Z'\\.\\s-]+$/`.",
"example": "JOHN DOE"
},
"gender": {
"type": "string",
"enum": [
"male",
"female"
],
"example": "male"
},
"email": {
"example": "example@example.com",
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"active",
"closed",
"suspended",
"activation",
"compliance_blocked"
],
"example": "active"
},
"nationality": {
"type": "string",
"example": "DE",
"description": "ISO 3166-1 alpha-2 country code"
},
"cards": {
"type": "array",
"example": [
{
"id": 1,
"name": "Example Card Name",
"pan4": "1234"
}
]
},
"dateOfBirth": {
"type": "string",
"example": "2024-12-26"
},
"phoneNumber": {
"type": "string",
"example": "+4593872813",
"description": "E164 format phone number"
},
"shipToBusinessPartnerAddress": {
"default": true,
"example": true,
"type": "boolean",
"description": "Ship to business partner address or custom? true if want to ship to business partner address. false if want to send to custom address."
},
"shippingAddress": {
"type": "string",
"example": "Broadway 1",
"description": "If **shipToBusinessPartnerAddress**=false use this field for the Street and Street Number of the custom address."
},
"shippingCity": {
"type": "string",
"example": "London",
"description": "If **shipToBusinessPartnerAddress**=false use this field for City of the custom address."
},
"shippingCountry": {
"description": "ISO 3166-1 alpha-2 country code. If **shipToBusinessPartnerAddress**=false use this field for Country of the custom address.",
"type": "string",
"example": "DE"
},
"shippingZip": {
"type": "string",
"example": "11000",
"description": "If **shipToBusinessPartnerAddress**=false use this field for the Zip Code of the custom address."
},
"shippingStateOrProvince": {
"type": "string",
"example": "TX",
"description": "If **shipToBusinessPartnerAddress**=false use this field for the US State of the custom address. Used just for US."
},
"shippingCompany": {
"type": "string",
"example": "Joe Doe",
"description": "Will be set to the first name and last name of the cardholder. If **shipToBusinessPartnerAddress**=false the physical cards will be sent to \"c/o firstName lastName\"."
}
}
},
"CardTransactionDetail-CardTransactionDetailView": {
"type": "object",
"description": "Retrieves card transaction information",
"deprecated": false,
"properties": {
"id": {
"example": 1,
"type": "integer"
},
"currency": {
"example": "CHF",
"type": "string"
},
"amount": {
"example": "100.00",
"type": "string"
},
"originalCurrency": {
"example": "CHF",
"type": "string"
},
"originalAmount": {
"example": "100.00",
"type": "string"
},
"type": {
"example": "transaction",
"type": "string",
"enum": [
"authorization",
"transaction",
"reversal"
]
},
"executionDate": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"settlementDate": {
"example": "2023-01-01T00:00:00+00:00",
"type": [
"string",
"null"
]
},
"status": {
"example": "executed",
"type": "string",
"enum": [
"executed",
"pending"
]
},
"card": {
"example": {
"id": 1,
"name": "Example Card Name",
"pan4": "1234"
},
"$ref": "#/components/schemas/Card-CardTransactionDetailView"
},
"merchant": {
"example": {
"id": 1,
"name": "Example Merchant Name Italy",
"country": "IT",
"mccCode": "1234"
},
"$ref": "#/components/schemas/Merchant-CardTransactionDetailView"
},
"documents": {
"$ref": "#/components/schemas/Document-TransactionView"
},
"expenseCategory": {
"$ref": "#/components/schemas/ExpenseCategory-TransactionView"
},
"expenseCostCenter": {
"$ref": "#/components/schemas/ExpenseCostCenter-TransactionView"
},
"comment": {
"example": "Travel expense",
"type": [
"string",
"null"
]
},
"vat": {
"example": [
{
"rate": "5",
"amount": "20"
},
{
"rate": "10",
"amount": "30"
}
],
"type": "array",
"items": {
"type": "string"
}
},
"createdAt": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"updatedAt": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"magicLinkUrl": {
"example": "https://app.amnis.com/expenses-public/4cb001f8-2b57-4b4a-8d2c-7d1a2f3b4c5d",
"type": [
"string",
"null"
]
},
"error": {
"example": {
"key": "card.expired",
"message": "Card expired"
},
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
},
"Contact-ContactView": {
"type": "object",
"description": "Retrieves contact information",
"deprecated": false,
"properties": {
"id": {
"example": 1,
"type": "integer"
},
"name": {
"example": "AMNIS Treasury Services AG",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"legal_entity",
"person"
],
"example": "legal_entity"
},
"country": {
"example": "CH",
"type": "string"
},
"address": {
"example": "Baslerstrasse 60",
"type": [
"string",
"null"
]
},
"city": {
"example": "Z\u00fcrich",
"type": [
"string",
"null"
]
},
"zip": {
"example": "8048",
"type": [
"string",
"null"
]
},
"state": {
"example": "Canton of Z\u00fcrich",
"type": [
"string",
"null"
]
},
"language": {
"type": "string",
"enum": [
"en",
"de",
"fr",
"it",
"cs",
"pl"
],
"example": "en"
},
"selfContact": {
"type": "boolean"
},
"expenseCategory": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Travels"
}
}
},
"expenseCostCenter": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Finance"
}
}
},
"expenseVat": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Standard VAT"
},
"value": {
"type": "string",
"example": "8.1"
}
}
},
"autoCompleteExpenseManagement": {
"type": "boolean",
"description": "Whether accounting details from the contact should automatically mark related expense management as completed.",
"example": false
}
}
},
"DealRequest-DealRequestView": {
"type": "object",
"description": "Create a new Deal Request",
"deprecated": false,
"properties": {
"id": {
"readOnly": true,
"example": 1,
"type": "string"
},
"currencyFrom": {
"example": "CHF",
"type": [
"string",
"null"
]
},
"currencyTo": {
"example": "EUR",
"type": [
"string",
"null"
]
},
"amountFrom": {
"pattern": "^(\\d+.\\d\\d)$",
"example": "100.00",
"type": [
"string",
"null"
]
},
"amountTo": {
"pattern": "^(\\d+.\\d\\d)$",
"example": "105.53",
"type": [
"string",
"null"
]
},
"valueDate": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"spotRate": {
"example": "1.0553",
"type": [
"string",
"null"
]
},
"platformRate": {
"example": "1.0553",
"type": [
"string",
"null"
]
},
"forwardPoints": {
"example": "1.0553",
"type": [
"string",
"null"
]
}
},
"required": [
"currencyFrom",
"currencyTo",
"valueDate"
]
},
"DealRequest.FxTransactionDetailCreateDTO": {
"type": "object",
"description": "Create a new Deal Request",
"deprecated": false,
"required": [
"currencyFrom",
"currencyTo",
"valueDate"
],
"properties": {
"currencyFrom": {
"example": "CHF",
"type": "string"
},
"currencyTo": {
"example": "EUR",
"type": "string"
},
"amountTo": {
"pattern": "^(\\d+.\\d\\d)$",
"example": "105.53",
"type": [
"string",
"null"
]
},
"amountFrom": {
"pattern": "^(\\d+.\\d\\d)$",
"example": "105.53",
"type": [
"string",
"null"
]
},
"valueDate": {
"example": "2023-01-01",
"type": "string",
"format": "date-time"
}
}
},
"Document-DocumentView": {
"type": "object",
"description": "Get expense documents information",
"deprecated": false,
"properties": {
"id": {
"example": 1,
"type": "string"
},
"name": {
"example": "document.pdf",
"type": [
"string",
"null"
]
},
"mimeType": {
"example": "application/pdf",
"type": "string"
},
"transactionId": {
"example": "1",
"type": [
"integer",
"null"
]
},
"createdAt": {
"type": "string",
"description": "Datetime of the creation in format Y-m-d H:i:s.",
"example": "2027-11-22 13:00:00"
}
}
},
"Expense.VAT-ExpenseVATCreate": {
"type": "object",
"description": "Creates a new expense VAT",
"deprecated": false,
"required": [
"name",
"value"
],
"properties": {
"name": {
"example": "Travels",
"type": "string"
},
"value": {
"example": "11",
"type": "string"
},
"externalId": {
"example": "11234534",
"type": [
"string",
"null"
]
},
"importTax": {
"example": "11",
"type": "boolean"
}
}
},
"Expense.VAT-ExpenseVATView": {
"type": "object",
"description": "Retrieves expense VAT information",
"deprecated": false,
"properties": {
"id": {
"type": "integer"
},
"name": {
"example": "Travels",
"type": "string"
},
"value": {
"example": "11",
"type": "string"
},
"externalId": {
"example": "11234534",
"type": [
"string",
"null"
]
},
"importTax": {
"example": "11",
"type": "boolean"
}
}
},
"ExpenseCategory-ExpenseCategoryCreate": {
"type": "object",
"description": "Creates a new expense category",
"deprecated": false,
"required": [
"name"
],
"properties": {
"name": {
"example": "Travels",
"type": "string"
},
"accountingAccountNumber": {
"example": "123132",
"type": [
"string",
"null"
]
},
"externalId": {
"example": "123132",
"type": [
"string",
"null"
]
},
"allowedTransactionTypes": {
"type": "string",
"enum": [
"card_transaction",
"fee_transaction",
"fx_transaction",
"payin_transaction",
"payout_transaction",
"wallet_transaction"
],
"example": [
"fee_transaction",
"fx_transaction"
]
},
"allowedCardGroups": {
"type": "string",
"example": [
"2",
"7"
]
}
}
},
"ExpenseCategory-ExpenseCategoryView": {
"type": "object",
"description": "Retrieves expense category information",
"deprecated": false,
"properties": {
"id": {
"type": "integer"
},
"name": {
"example": "Travels",
"type": "string"
},
"accountingAccountNumber": {
"example": "123132",
"type": [
"string",
"null"
]
},
"externalId": {
"example": "123132",
"type": [
"string",
"null"
]
},
"allowedTransactionTypes": {
"type": "string",
"enum": [
"card_transaction",
"fee_transaction",
"fx_transaction",
"payin_transaction",
"payout_transaction",
"wallet_transaction"
],
"example": [
"fee_transaction",
"fx_transaction"
]
},
"allowedCardGroups": {
"type": "string",
"example": [
"2",
"7"
]
}
}
},
"ExpenseCostCenter-ExpenseCostCenterCreate": {
"type": "object",
"description": "Creates a new expense cost center",
"deprecated": false,
"required": [
"name"
],
"properties": {
"name": {
"example": "Finance",
"type": "string"
},
"number": {
"example": "123145",
"type": [
"string",
"null"
]
},
"allowedTransactionTypes": {
"type": "string",
"enum": [
"card_transaction",
"fee_transaction",
"fx_transaction",
"payin_transaction",
"payout_transaction",
"wallet_transaction"
],
"example": [
"fee_transaction",
"fx_transaction"
]
},
"allowedCardGroups": {
"type": "string",
"example": [
"2",
"7"
]
}
}
},
"ExpenseCostCenter-ExpenseCostCenterView": {
"type": "object",
"description": "Retrieves expense cost center information",
"deprecated": false,
"properties": {
"id": {
"type": "integer"
},
"name": {
"example": "Finance",
"type": "string"
},
"number": {
"example": "123145",
"type": [
"string",
"null"
]
},
"allowedTransactionTypes": {
"type": "string",
"enum": [
"card_transaction",
"fee_transaction",
"fx_transaction",
"payin_transaction",
"payout_transaction",
"wallet_transaction"
],
"example": [
"fee_transaction",
"fx_transaction"
]
},
"allowedCardGroups": {
"type": "string",
"example": [
"2",
"7"
]
}
}
},
"ExpenseVAT-ExpenseVATView": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"id": {
"readOnly": true,
"type": "integer"
},
"businessPartner": {
"type": "string",
"format": "iri-reference",
"example": "https://example.com/"
},
"value": {
"minimum": 0,
"type": "number"
},
"name": {
"type": [
"string",
"null"
]
},
"externalId": {
"type": [
"string",
"null"
]
},
"visible": {
"default": true,
"example": true,
"type": "boolean"
},
"importTax": {
"type": "boolean"
}
},
"required": [
"businessPartner",
"value"
]
},
"FeeTransactionDetail-FeeTransactionDetailView": {
"type": "object",
"description": "Retrieves fee information",
"deprecated": false,
"properties": {
"id": {
"example": 1,
"type": "integer"
},
"account": {
"example": 1,
"type": "integer"
},
"currency": {
"example": "CHF",
"type": "string"
},
"amount": {
"example": "10.00",
"type": "string"
},
"executionDate": {
"example": "2023-01-01T00:00:00+00:00",
"type": [
"string",
"null"
]
},
"comment": {
"example": "Fee related comment",
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"executed"
],
"example": "executed"
}
}
},
"FxTransactionDetail-FxTransactionDetailView": {
"type": "object",
"description": "Retrieves FX transaction information",
"deprecated": false,
"properties": {
"id": {
"example": 1,
"type": "integer"
},
"currencyFrom": {
"example": "CHF",
"type": "string"
},
"currencyTo": {
"example": "EUR",
"type": "string"
},
"amountFrom": {
"example": "100.00",
"type": "string"
},
"amountTo": {
"example": "105.53",
"type": "string"
},
"direction": {
"type": "string",
"enum": [
"sell",
"buy"
],
"example": "sell"
},
"dealDate": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"valueDate": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"spot",
"forward"
],
"example": "forward"
},
"spotRate": {
"example": "1.0553",
"type": "string"
},
"forwardPoints": {
"example": "1.0553",
"type": [
"string",
"null"
]
},
"platformRate": {
"example": "1.0553",
"type": "string"
},
"status": {
"type": "string",
"enum": [
"created",
"pending",
"transferred",
"canceled"
],
"example": "hedged"
},
"fromAutomation": {
"type": "boolean"
}
}
},
"FxTransactionDetail.FxTransactionDetailCreateDTO": {
"type": "object",
"description": "Create FX transaction",
"deprecated": false,
"required": [
"currencyFrom",
"currencyTo",
"valueDate"
],
"properties": {
"currencyFrom": {
"example": "CHF",
"type": "string"
},
"currencyTo": {
"example": "EUR",
"type": "string"
},
"amountTo": {
"pattern": "^(\\d+.\\d\\d)$",
"example": "105.53",
"type": [
"string",
"null"
]
},
"amountFrom": {
"pattern": "^(\\d+.\\d\\d)$",
"example": "105.53",
"type": [
"string",
"null"
]
},
"valueDate": {
"example": "2023-01-01",
"type": "string",
"format": "date-time"
}
}
},
"Info": {
"type": "object",
"description": "Retrieves info about the account",
"deprecated": false,
"properties": {
"id": {
"example": 1,
"type": "integer"
},
"legalForm": {
"example": "public limited company",
"type": [
"string",
"null"
]
},
"countryOfIncorporation": {
"example": "CH",
"type": [
"string",
"null"
]
},
"address": {
"example": "Baslerstrasse 60",
"type": [
"string",
"null"
]
},
"city": {
"example": "Z\u00fcrich",
"type": [
"string",
"null"
]
},
"zip": {
"example": "8048",
"type": [
"string",
"null"
]
},
"stateOrProvince": {
"example": "Canton of Z\u00fcrich",
"type": [
"string",
"null"
]
},
"activePackage": {
"example": 1,
"type": "integer"
},
"availableBalance": {
"$ref": "#/components/schemas/AvailableBalance"
}
}
},
"PayPalOrder-PayPalOrderView": {
"type": "object",
"description": "Create a PayPal Order",
"deprecated": false,
"properties": {
"id": {
"example": "6MR709191W4328148",
"type": "string"
}
}
},
"PayPalOrder.PayPalOrderCreateDTO": {
"type": "object",
"description": "Create a PayPal Order",
"deprecated": false,
"required": [
"referenceId",
"description",
"amount",
"returnUrl",
"cancelUrl"
],
"properties": {
"referenceId": {
"example": "ORDER-REF-12345",
"type": "string"
},
"description": {
"example": "Payment for invoice INV-2024-001",
"type": "string"
},
"amount": {
"$ref": "#/components/schemas/PayPalOrderAmountDTO"
},
"returnUrl": {
"format": "uri",
"externalDocs": {
"url": "https://schema.org/url"
},
"example": "https://example.com/paypal/return",
"type": "string"
},
"cancelUrl": {
"format": "uri",
"externalDocs": {
"url": "https://schema.org/url"
},
"example": "https://example.com/paypal/cancel",
"type": "string"
}
}
},
"PayinTransactionDetail-PayinTransactionDetailView": {
"type": "object",
"description": "Retrieves pay-in payment information",
"deprecated": false,
"properties": {
"id": {
"example": 1,
"type": "integer"
},
"currency": {
"example": "CHF",
"type": "string"
},
"amount": {
"example": "100.00",
"type": "string"
},
"executionDate": {
"example": "2023-01-01T00:00:00+00:00",
"type": [
"string",
"null"
]
},
"comment": {
"example": "Comment",
"type": [
"string",
"null"
]
},
"subType": {
"type": "string",
"enum": [
"pay_in",
"returned_payment"
],
"example": "pay_in"
},
"payerName": {
"example": "Name of the payer",
"type": [
"string",
"null"
]
},
"qrReference": {
"example": "QR reference",
"type": [
"string",
"null"
]
},
"isInstant": {
"type": "boolean"
}
}
},
"PayoutTransactionDetail-PayoutTransactionDetailCreate": {
"type": "object",
"description": "Creates a new payment",
"deprecated": false,
"required": [
"amount",
"reference",
"bankAccount"
],
"properties": {
"amount": {
"example": "100.00",
"type": [
"string",
"null"
]
},
"executionDate": {
"description": "If left empty, the next possible execution date will be selected automatically",
"example": "2023-01-01T00:00:00+00:00",
"type": [
"string",
"null"
]
},
"reference": {
"minLength": 3,
"maxLength": 140,
"description": "This text will be seen by the beneficiary",
"example": "Payment for car rental",
"type": [
"string",
"null"
]
},
"feeSchedule": {
"enum": [
"DEBT",
"SHAR",
"CRED"
],
"maxLength": 4,
"description": "For LOCAL payments leave it empty, for SWIFT payments provide a value",
"type": "string",
"example": "SHAR"
},
"beneficiary": {
"description": "The beneficiary field is required, except for payments to IBANs linked to existing amnis customers.",
"anyOf": [
{
"$ref": "#/components/schemas/Beneficiary-PayoutTransactionDetailCreate"
},
{
"type": "null"
}
]
},
"bankAccount": {
"anyOf": [
{
"$ref": "#/components/schemas/BankAccount-PayoutTransactionDetailCreate"
},
{
"type": "null"
}
]
},
"externalId": {
"description": "This should be a unique ID used to identify this payment in your system.",
"example": "f0f94bbd-bd5c-48a8-b45d-f32a376c7ffe",
"type": [
"string",
"null"
]
}
}
},
"PayoutTransactionDetail-PayoutTransactionDetailView": {
"type": "object",
"description": "Retrieves payout transaction MT103 information",
"deprecated": false,
"properties": {
"id": {
"example": 1,
"type": "integer"
},
"account": {
"example": 1,
"type": "integer"
},
"currency": {
"example": "CHF",
"type": "string"
},
"amount": {
"example": "100.00",
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"created",
"pending",
"transferred",
"canceled",
"pending_execution",
"executed",
"execution_error"
],
"example": "executed"
},
"executionDate": {
"description": "If left empty, the next possible execution date will be selected automatically",
"example": "2023-01-01T00:00:00+00:00",
"type": [
"string",
"null"
]
},
"transferredAt": {
"example": "2023-01-01T00:00:00+00:00",
"type": [
"string",
"null"
]
},
"finishedAt": {
"example": "2023-01-01T00:00:00+00:00",
"type": [
"string",
"null"
]
},
"reference": {
"description": "This text will be seen by the beneficiary",
"example": "Payment for car rental",
"type": [
"string",
"null"
]
},
"feeSchedule": {
"description": "For LOCAL payments leave it empty, for SWIFT payments provide a value",
"type": "string",
"enum": [
"DEBT",
"SHAR",
"CRED"
],
"example": "SHAR"
},
"contact": {
"example": 1,
"type": "integer"
},
"beneficiary": {
"description": "The beneficiary field is required, except for payments to IBANs linked to existing amnis customers.",
"anyOf": [
{
"$ref": "#/components/schemas/Beneficiary-PayoutTransactionDetailView"
},
{
"type": "null"
}
]
},
"fromAutomation": {
"type": "boolean"
}
}
},
"RebelAccount-RebelAccountView": {
"type": "object",
"description": "Retrieves pay-in payment information",
"deprecated": false,
"properties": {
"resourceId": {
"example": 1,
"type": "integer"
},
"iban": {
"example": "CH8589144564374146431",
"type": "string"
},
"currency": {
"example": "CHF",
"type": "string"
},
"name": {
"example": "CHF Main Account",
"type": "string"
}
}
},
"RebelConsent": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"consentId": {
"example": "7b27dab5-2211-4a9f-95b2-8f4ebd8b47ae",
"type": [
"string",
"null"
]
},
"consentStatus": {
"type": [
"string",
"null"
]
},
"_links": {
"readOnly": true,
"type": "array",
"items": {
"type": "string"
}
},
"scaOAuth": {
"readOnly": true,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"RebelConsent-ConsentCreateView": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"consentId": {
"example": "7b27dab5-2211-4a9f-95b2-8f4ebd8b47ae",
"type": [
"string",
"null"
]
},
"consentStatus": {
"type": [
"string",
"null"
]
},
"scaOAuth": {
"readOnly": true,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"RebelConsent-ConsentView": {
"type": "object",
"description": "",
"deprecated": false,
"properties": {
"consentId": {
"example": "7b27dab5-2211-4a9f-95b2-8f4ebd8b47ae",
"type": [
"string",
"null"
]
},
"consentStatus": {
"type": [
"string",
"null"
]
},
"_links": {
"readOnly": true,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Transaction-TransactionView_FeeTransactionDetailView_FxTransactionDetailView_CardTransactionDetailView_PayinTransactionDetailView_PayoutTransactionDetailView_WalletTransactionDetailView": {
"type": "object",
"description": "Retrieves transaction information",
"deprecated": false,
"properties": {
"id": {
"example": "1",
"type": "integer"
},
"currency": {
"example": "CHF",
"type": "string"
},
"amount": {
"example": "100.00",
"type": "string"
},
"type": {
"example": "payin",
"type": "string",
"enum": [
"fee",
"payin",
"payout",
"peer",
"fx",
"card"
]
},
"executionDate": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"executed": {
"example": true,
"type": "boolean"
},
"createdAt": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"updatedAt": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"account": {
"example": 1,
"type": "integer"
},
"transactionDetailId": {
"example": 1,
"type": [
"integer",
"null"
]
},
"tags": {
"example": [
"tag1",
"tag2"
],
"type": "array",
"items": {
"type": "string"
}
},
"documents": {
"$ref": "#/components/schemas/Document-TransactionView"
},
"expenseCategory": {
"$ref": "#/components/schemas/ExpenseCategory-TransactionView"
},
"expenseCostCenter": {
"$ref": "#/components/schemas/ExpenseCostCenter-TransactionView"
},
"vat": {
"example": [
{
"rate": "5",
"amount": "20",
"grossAmount": "120"
},
{
"rate": "10",
"amount": "30",
"grossAmount": "330"
}
],
"type": "array",
"items": {
"type": "string"
}
},
"comment": {
"type": [
"string",
"null"
]
},
"expenseCompletedAt": {
"example": "2023-01-01T00:00:00+00:00",
"type": [
"string",
"null"
]
},
"magicLinkUrl": {
"example": "https://app.amnis.com/expenses-public/4cb001f8-2b57-4b4a-8d2c-7d1a2f3b4c5d",
"type": [
"string",
"null"
]
},
"contact": {
"$ref": "#/components/schemas/Contact-TransactionView"
}
}
},
"Transaction.TransactionExpenseCompletedDTO-TransactionExpenseComplete": {
"type": "object",
"description": "Toggles expense completion for a transaction",
"deprecated": false,
"properties": {
"markAsComplete": {
"example": true,
"type": [
"boolean",
"null"
]
}
}
},
"Transaction.TransactionExpenseUpdateDTO-TransactionExpenseUpdate": {
"type": "object",
"description": "Updates expense information for a transaction",
"deprecated": false,
"properties": {
"category": {
"example": "/api/expense_categories/1",
"type": [
"string",
"null"
]
},
"costCenter": {
"example": "/api/expense_cost_centers/1",
"type": [
"string",
"null"
]
},
"vatRate": {
"example": [
"7.7",
"2.5"
],
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"vatAmount": {
"example": [
"100.00",
"50.00"
],
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"note": {
"example": "Team lunch",
"type": [
"string",
"null"
]
}
}
},
"WalletTransactionDetail-WalletTransactionDetailView": {
"type": "object",
"description": "Retrieves PEER payment information",
"deprecated": false,
"properties": {
"id": {
"example": 1,
"type": "integer"
},
"currency": {
"example": "CHF",
"type": "string"
},
"amount": {
"example": "100.00",
"type": "string"
},
"executionDate": {
"example": "2023-01-01T00:00:00+00:00",
"type": "string"
},
"collateral": {
"type": "boolean"
},
"side": {
"type": "string",
"enum": [
"sender",
"receiver"
],
"example": "sender"
},
"senderCompanyName": {
"example": "Example Sender Company AG",
"type": "string"
},
"receiverCompanyName": {
"example": "Example Receiver Company AG",
"type": "string"
},
"senderAccount": {
"example": 1,
"type": [
"integer",
"null"
]
},
"receiverAccount": {
"example": 2,
"type": [
"integer",
"null"
]
},
"comment": {
"example": "Example comment",
"type": [
"string",
"null"
]
},
"contact": {
"example": 1,
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"created",
"pending",
"transferred",
"canceled"
],
"example": "transferred"
},
"fromAutomation": {
"type": "boolean"
}
}
},
"AuthenticationFailed": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
}
}
},
"AccessDenied": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
}
}
},
"AvailableBalance": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"nullable": true
},
"amount": {
"type": "string"
}
}
},
"Beneficiary-PayoutTransactionDetailView": {
"type": "object",
"properties": {
"accountNumber": {
"type": "string"
},
"bankName": {
"type": "string",
"nullable": true
},
"bankCountry": {
"type": "string",
"nullable": true
},
"name": {
"type": "string"
},
"address": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"zip": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"contact": {
"type": "string",
"nullable": true
}
}
},
"Beneficiary-PayoutTransactionDetailCreate": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"zip": {
"type": "string"
},
"country": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"BankAccount-PayoutTransactionDetailCreate": {
"type": "object",
"properties": {
"iban": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"swift": {
"type": "string"
},
"currency": {
"type": "string"
},
"country": {
"type": "string"
},
"additionalFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "qrReference"
},
"value": {
"type": "string",
"example": "210000000003139471430009017"
}
}
},
"nullable": true
}
}
},
"Card-CardHolderView": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"pan4": {
"type": "string"
}
}
},
"Card-CardTransactionDetailView": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"pan4": {
"type": "string"
}
}
},
"Document-TransactionView": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": "1"
},
"name": {
"type": "string",
"example": "example_document.jpg"
},
"mimeType": {
"type": "string",
"example": "image/jpeg"
}
}
},
"Document-TransactionView_FeeTransactionDetailView_FxTransactionDetailView_CardTransactionDetailView_PayinTransactionDetailView_PayoutTransactionDetailView_WalletTransactionDetailView": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"mimeType": {
"type": "string"
}
}
},
"ClientCredentialsAuthenticationOutput": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"expires_in": {
"type": "string",
"example": 3600
},
"token_type": {
"type": "string",
"example": "Bearer"
}
}
},
"ClientCredentialsAuthenticationBody": {
"type": "object",
"required": [
"grant_type",
"client_id",
"client_secret"
],
"properties": {
"grant_type": {
"type": "string",
"enum": [
"client_credentials"
]
},
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"USER",
"PAYMENT_CREATE",
"CARD_MANAGEMENT",
"FX",
"ACCOUNTING",
"PAYPAL"
]
}
}
}
},
"Merchant-CardTransactionDetailView": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"country": {
"type": "string"
},
"mccCode": {
"type": "string"
}
}
},
"Tag-View": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"BadRequestException": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"detail": {
"type": "string"
}
}
},
"ExpenseCategory-TransactionView": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": "1"
},
"name": {
"type": "string",
"example": "Travel expense"
},
"accountingAccountNumber": {
"type": "string",
"example": "123456"
},
"externalId": {
"type": "string",
"example": "abcefg"
}
}
},
"ExpenseCostCenter-TransactionView": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": "1"
},
"name": {
"type": "string",
"example": "Travel expense"
},
"number": {
"type": "string",
"example": "123456"
}
}
},
"PayPalOrderAmountDTO": {
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"example": "USD"
},
"value": {
"type": "number",
"example": 10
}
}
},
"Contact-TransactionView": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": "1"
}
}
}
},
"responses": {},
"parameters": {},
"examples": {},
"requestBodies": {},
"headers": {},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"security": [],
"tags": [],
"webhooks": {}
}