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.

post

/v1/add-payment

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/add-payment' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "expenseId": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "transactionTimestamp": 1,
    "transactionDate": "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

Match payment with an existing Transaction

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

post

/v1/match-payment/{transactionId}

Authorizations

Path parameters

transactionIdstring · uuidrequired

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/match-payment/{transactionId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "incomeId": "123e4567-e89b-12d3-a456-426614174000",
    "expenseId": "123e4567-e89b-12d3-a456-426614174000",
    "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