Accounts & Transactions

READ Scope

List all Accounts

Retrieves the list of all available bank and cash accounts

get

/v1/accounts

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/accounts' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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
    }
  ]
}

OK

Get an Account by ID

Retrieves an account by its unique ID

get

/v1/accounts/{id}

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/accounts/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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
  }
}

OK

List all Transactions

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

get

/v1/transactions

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/transactions' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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
        }
      ]
    }
  ]
}

OK

Get a Transaction by ID

Retrieves a single transaction by its unique ID

get

/v1/transactions/{id}

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/transactions/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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
      }
    ]
  }
}

OK

WRITE Scope

Create a new Account

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.

post

/v1/accounts

Authorizations

Body

application/jsontext/jsonapplication/*+json

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.nuvio.io/v1/accounts' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "iban": "text",
    "currency": "text",
    "openingBalance": 1
  }'

200

200

{
  "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
  }
}

OK

Add a new Transaction

Adds a new transaction into an existing account.

post

/v1/transactions

Authorizations

Body

application/jsontext/jsonapplication/*+json

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.nuvio.io/v1/transactions' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "transactionTimestamp": 1,
    "transactionDate": "text",
    "transactionType": "text",
    "mathcingEntityId": "123e4567-e89b-12d3-a456-426614174000",
    "mathcingEntityCode": "text",
    "amount": 1
  }'

200

200

{
  "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
      }
    ]
  }
}

OK

UPDATE Scope

Update Account

Updates an existing bank or cash account.

put

/v1/accounts/{id}

Authorizations

Path parameters

idstring · uuidrequired

Body

application/jsontext/jsonapplication/*+json

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.nuvio.io/v1/accounts/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "iban": "text",
    "currency": "text",
    "openingBalance": 1
  }'

200

200

{
  "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
  }
}

OK

Update Transaction

Updates an existing transaction.

put

/v1/transactions/{id}

Authorizations

Path parameters

idstring · uuidrequired

Body

application/jsontext/jsonapplication/*+json

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.nuvio.io/v1/transactions/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "transactionTimestamp": 1,
    "transactionDate": "text",
    "transactionType": "text",
    "mathcingEntityId": "123e4567-e89b-12d3-a456-426614174000",
    "mathcingEntityCode": "text",
    "amount": 1
  }'

200

200

{
  "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
      }
    ]
  }
}

OK