Accounts & Transactions

READ Scope

List all Accounts

get

Retrieves the list of all available bank and cash accounts

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

get

/v1/accounts

HTTPcURLJavaScriptPython

GET /v1/accounts HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "iban": "text",
      "integrationType": "text",
      "currency": "text",
      "type": "text",
      "openingBalance": 1,
      "currentBalance": 1
    }
  ]
}

Get an Account by ID

get

Retrieves an account by its unique ID

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Path parameters

idstring · uuidRequired

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

get

/v1/accounts/{id}

HTTPcURLJavaScriptPython

GET /v1/accounts/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "iban": "text",
    "integrationType": "text",
    "currency": "text",
    "type": "text",
    "openingBalance": 1,
    "currentBalance": 1
  }
}

List all Transactions

get

Retrieves the list of transactions in all accounts bank and cash accounts

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

get

/v1/transactions

HTTPcURLJavaScriptPython

GET /v1/transactions HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "accountName": "text",
      "description": "text",
      "transactionTimestamp": 1,
      "transactionDate": "text",
      "amount": 1,
      "currency": "text",
      "transactionType": "text",
      "matchedEntity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text"
      },
      "matchedIncomes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "invoiceId": "text",
          "matchedAmount": 1
        }
      ],
      "matchedExpenses": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "expenseId": "text",
          "matchedAmount": 1
        }
      ]
    }
  ]
}

Get a Transaction by ID

get

Retrieves a single transaction by its unique ID

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Path parameters

idstring · uuidRequired

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

get

/v1/transactions/{id}

HTTPcURLJavaScriptPython

GET /v1/transactions/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "accountName": "text",
    "description": "text",
    "transactionTimestamp": 1,
    "transactionDate": "text",
    "amount": 1,
    "currency": "text",
    "transactionType": "text",
    "matchedEntity": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text"
    },
    "matchedIncomes": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "matchedAmount": 1
      }
    ],
    "matchedExpenses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "expenseId": "123e4567-e89b-12d3-a456-426614174000",
        "matchedAmount": 1
      }
    ]
  }
}

WRITE Scope

Create a new Account

post

Creates a new bank or cash account. Accounts created with this endpoint are manually tracked bank accounts. To integrate your existing bank account into Nuvio, please contact with support team.

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Body

application/jsontext/jsonapplication/*+json

namestring · min: 1Required

Account name

ibanstringOptional

IBAN of this bank account.

currencystring · min: 1Required

3-letter currency code for the account. You can find available currencies here.

openingBalancenumber · doubleOptional

Opening Balance to start with an existing account. It should be a decimal number with 2 decimal points. eg. 1059.34

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

post

/v1/accounts

HTTPcURLJavaScriptPython

POST /v1/accounts HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "name": "text",
  "iban": "text",
  "currency": "text",
  "openingBalance": 1
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "iban": "text",
    "integrationType": "text",
    "currency": "text",
    "type": "text",
    "openingBalance": 1,
    "currentBalance": 1
  }
}

Add a new Transaction

post

Adds a new transaction into an existing account.

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Body

application/jsontext/jsonapplication/*+json

accountIdstring · uuidRequired

32-character unique ID of the account that the transaction belongs.

descriptionstring · min: 1Required

Description of the transaction

transactionTimestampinteger · int64Optional

Epoch timestamp for the transaction date and time. If you don't know the timestamp, you can also provice transactionDate. If both of the fields are provided, transactionTimestamp will be used.

transactionDatestringOptional

Datetime with timezone for the transaction date and time. You can also provide transactionTimestamp. If both of the fields are provided, transactionTimestamp will be used.

transactionTypestringOptional

Type of the transaction. If it is an incoming money, use Money In; if it is an outgoing money, use Money Out

mathcingEntityIdstring · uuid · nullableOptional

32-character unique ID of the customer or supplier of the transaction's sender or receiver. If you don't know the ID, you can also provide mathcingEntityCode instead of this field. If both of them are provided, matchingEntityId will be used only.

mathcingEntityCodestringOptional

User-generated custom customer or supplier code of the transaction's sender or receiver.

amountnumber · doubleOptional

Amount of the transaction. It should be a positive decimal number. eg. 1059.34

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

post

/v1/transactions

HTTPcURLJavaScriptPython

POST /v1/transactions HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "transactionTimestamp": 1,
  "transactionDate": "text",
  "transactionType": "text",
  "mathcingEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "mathcingEntityCode": "text",
  "amount": 1
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "accountName": "text",
    "description": "text",
    "transactionTimestamp": 1,
    "transactionDate": "text",
    "amount": 1,
    "currency": "text",
    "transactionType": "text",
    "matchedEntity": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text"
    },
    "matchedIncomes": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "matchedAmount": 1
      }
    ],
    "matchedExpenses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "expenseId": "123e4567-e89b-12d3-a456-426614174000",
        "matchedAmount": 1
      }
    ]
  }
}

UPDATE Scope

Update Account

put

Updates an existing bank or cash account.

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Path parameters

idstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

namestringOptional

Account name

ibanstringOptional

IBAN of this bank account.

currencystringOptional

3-letter currency code for the account. You can find available currencies here.

openingBalancenumber · double · nullableOptional

Opening Balance to start with an existing account. It should be a decimal number with 2 decimal points. eg. 1059.34

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

put

/v1/accounts/{id}

HTTPcURLJavaScriptPython

PUT /v1/accounts/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "name": "text",
  "iban": "text",
  "currency": "text",
  "openingBalance": 1
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "iban": "text",
    "integrationType": "text",
    "currency": "text",
    "type": "text",
    "openingBalance": 1,
    "currentBalance": 1
  }
}

Update Transaction

put

Updates an existing transaction.

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Path parameters

idstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

descriptionstringOptional

Description of the transaction

transactionTimestampinteger · int64Optional

Epoch timestamp for the transaction date and time. If you don't know the timestamp, you can also provice transactionDate. If both of the fields are provided, transactionTimestamp will be used.

transactionDatestringOptional

Datetime with timezone for the transaction date and time. You can also provide transactionTimestamp. If both of the fields are provided, transactionTimestamp will be used.

transactionTypestringOptional

Type of the transaction. If it is an incoming money, use Money In; if it is an outgoing money, use Money Out

mathcingEntityIdstring · uuid · nullableOptional

32-character unique ID of the customer or supplier of the transaction's sender or receiver. If you don't know the ID, you can also provide mathcingEntityCode instead of this field. If both of them are provided, matchingEntityId will be used only.

mathcingEntityCodestringOptional

User-generated custom customer or supplier code of the transaction's sender or receiver.

amountnumber · double · nullableOptional

Amount of the transaction. It should be a positive decimal number. eg. 1059.34

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

put

/v1/transactions/{id}

HTTPcURLJavaScriptPython

PUT /v1/transactions/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "description": "text",
  "transactionTimestamp": 1,
  "transactionDate": "text",
  "transactionType": "text",
  "mathcingEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "mathcingEntityCode": "text",
  "amount": 1
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "accountName": "text",
    "description": "text",
    "transactionTimestamp": 1,
    "transactionDate": "text",
    "amount": 1,
    "currency": "text",
    "transactionType": "text",
    "matchedEntity": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text"
    },
    "matchedIncomes": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "matchedAmount": 1
      }
    ],
    "matchedExpenses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "expenseId": "123e4567-e89b-12d3-a456-426614174000",
        "matchedAmount": 1
      }
    ]
  }
}