Accounts & Transactions

READ Scope

List all Accounts

Retrieves the list of all available bank and cash accounts

GEThttps://api.nuvio.io/v1/accounts

Response

Body

successboolean

errorsnullable array of string

dataarray of Banks

Request

const response = await fetch('https://api.nuvio.io/v1/accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get an Account by ID

Retrieves an account by its unique ID

GEThttps://api.nuvio.io/v1/accounts/{id}

Path parameters

id*string (uuid)

Response

Body

successboolean

errorsnullable array of string

dataBank

Request

const response = await fetch('https://api.nuvio.io/v1/accounts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

List all Transactions

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

GEThttps://api.nuvio.io/v1/transactions

Response

Body

successboolean

errorsnullable array of string

dataarray of Transactions

Request

const response = await fetch('https://api.nuvio.io/v1/transactions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get a Transaction by ID

Retrieves a single transaction by its unique ID

GEThttps://api.nuvio.io/v1/transactions/{id}

Path parameters

id*string (uuid)

Response

Body

successboolean

errorsnullable array of string

dataTransaction

Request

const response = await fetch('https://api.nuvio.io/v1/transactions/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "accountName": "text",
    "description": "text",
    "transactionDate": "text",
    "amount": 0,
    "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": 0
      }
    ],
    "matchedExpenses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "expenseId": "123e4567-e89b-12d3-a456-426614174000",
        "matchedAmount": 0
      }
    ]
  }
}

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.

POSThttps://api.nuvio.io/v1/accounts

Body

name*string

Account name

ibanstring

IBAN of this bank account.

currency*string

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

openingBalancenumber (double)

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

Response

Body

successboolean

errorsnullable array of string

dataBank

Request

const response = await fetch('https://api.nuvio.io/v1/accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "currency": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

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

Add a new Transaction

Adds a new transaction into an existing account.

POSThttps://api.nuvio.io/v1/transactions

Body

accountId*string (uuid)

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

description*string

Description of the transaction

transactionTimestampinteger (int64)

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.

transactionDatestring

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.

transactionTypestring

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

mathcingEntityIdnullable string (uuid)

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.

mathcingEntityCodestring

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

amountnumber (double)

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

Response

Body

successboolean

errorsnullable array of string

dataTransaction

Request

const response = await fetch('https://api.nuvio.io/v1/transactions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "accountName": "text",
    "description": "text",
    "transactionDate": "text",
    "amount": 0,
    "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": 0
      }
    ],
    "matchedExpenses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "expenseId": "123e4567-e89b-12d3-a456-426614174000",
        "matchedAmount": 0
      }
    ]
  }
}

UPDATE Scope

Update Account

Updates an existing bank or cash account.

PUThttps://api.nuvio.io/v1/accounts/{id}

Path parameters

id*string (uuid)

Body

namestring

Account name

ibanstring

IBAN of this bank account.

currencystring

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

openingBalancenullable number (double)

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

Response

Body

successboolean

errorsnullable array of string

dataBank

Request

const response = await fetch('https://api.nuvio.io/v1/accounts/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Update Transaction

Updates an existing transaction.

PUThttps://api.nuvio.io/v1/transactions/{id}

Path parameters

id*string (uuid)

Body

descriptionstring

Description of the transaction

transactionTimestampinteger (int64)

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.

transactionDatestring

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.

transactionTypestring

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

mathcingEntityIdnullable string (uuid)

mathcingEntityCodestring

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

amountnullable number (double)

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

Response

Body

successboolean

errorsnullable array of string

dataTransaction

Request

const response = await fetch('https://api.nuvio.io/v1/transactions/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "accountName": "text",
    "description": "text",
    "transactionDate": "text",
    "amount": 0,
    "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": 0
      }
    ],
    "matchedExpenses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "expenseId": "123e4567-e89b-12d3-a456-426614174000",
        "matchedAmount": 0
      }
    ]
  }
}

PreviousErrors NextCustomers & Suppliers

Last updated 1 month ago

const response = await fetch('https://api.nuvio.io/v1/transactions', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "accountId": "123e4567-e89b-12d3-a456-426614174000", "description": "text" }), }); const data = await response.json();

{ "success": false, "errors": [ "text" ], "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "accountId": "123e4567-e89b-12d3-a456-426614174000", "accountName": "text", "description": "text", "transactionDate": "text", "amount": 0, "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": 0 } ], "matchedExpenses": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "expenseId": "123e4567-e89b-12d3-a456-426614174000", "matchedAmount": 0 } ] } }

const response = await fetch('https://api.nuvio.io/v1/transactions/{id}', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();