GuidesAPI ReferenceSign In

Accounts & Transactions

READ Scope

List all Accounts

get

Retrieves the list of all available bank and cash accounts

Authorizations
Responses
200
OK
application/json
get
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
Path parameters
idstring · uuidRequired
Responses
200
OK
application/json
get
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
Responses
200
OK
application/json
get
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
Path parameters
idstring · uuidRequired
Responses
200
OK
application/json
get
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
Body
all ofOptional
Responses
200
OK
application/json
post
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
}
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
Body
all ofOptional
Responses
200
OK
application/json
post
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
}
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
Path parameters
idstring · uuidRequired
Body
all ofOptional
Responses
200
OK
application/json
put
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
}
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
Path parameters
idstring · uuidRequired
Body
all ofOptional
Responses
200
OK
application/json
put
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
}
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
      }
    ]
  }
}
PreviousErrorsNextCustomers & Suppliers

Last updated