Payments

All API Operations related with payments of income and expenses

WRITE Scope

Record a new payment

Adds a new payment into for an income or expense. This endpoint also creates a new transaction in the provided account automatically. It works only for manually tracked accounts. If you would like to match an existing transaction with and income or expense please use 'Match Payment' endpoint.

POSThttps://api.nuvio.io/v1/add-payment

Body

application/jsontext/jsonapplication/*+json

invoiceIdstring (uuid)

32-character unique ID of the matching Invoice. If this payment does not match with an income, do not include this field while sending your request. you can include expenseId to match with an expense.

expenseIdstring (uuid)

32-character unique ID of the matching Expense. If this payment does not match with an expense, do not include this field while sending your request. you can include incomeId to match with an income.

accountId*string (uuid)

32-character unique ID of the bank or cash account of the transaction. This payment will be recorded into this account. Please make sure that the selected account's currency is the mathes with the income or expense's currency or with the company's functional currency. If the selected account's currency does not match any of those currencies, payment will not be recorded.

description*string

Description of the payment. Will also be used as the description of the added 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.

amountnumber (double)

The amount of the payment. This amount should be less or equal to matched income or expense's remaining balance.

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataTransaction

Request

JavaScriptCurlPython

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

Response

200

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

Match payment with an existing Transaction

Matches an existing transaction as the payment for an income or expense.

POSThttps://api.nuvio.io/v1/match-payment/{transactionId}

Path parameters

transactionId*string (uuid)

Body

application/jsontext/jsonapplication/*+json

incomeIdnullable string (uuid)

32-character unique ID of the matching income. If this payment does not match with an income, do not include this field while sending your request. you can include expenseId to match with an expense.

expenseIdnullable string (uuid)

32-character unique ID of the matching Expense. If this payment does not match with an expense, do not include this field while sending your request. you can include incomeId to match with an income.

amountnumber (double)

The amount of the payment. This amount should be less or equal to matched income or expense's remaining balance. It should also be less or equal to transaction's not-matched balance.

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataTransaction

Request

JavaScriptCurlPython

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

Response

200

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