Income

All API Operations related with Income

READ Scope

List all incomes

Retrieves all the incomes that match with provided filters

POSThttps://api.nuvio.io/v1/list-incomes

Body

application/jsontext/jsonapplication/*+json

startDatenullable string

Starting date to be applied to date filter. Should be formatted in YYYY-MM-DD format

endDatenullable string

End date to be applied to date filter. Should be formatted in YYYY-MM-DD format

customerIdnullable string (uuid)

32-character unique ID to filter a specific business entity. If you don't know the ID, you can also provide customerCode instead of this field. If both of them are provided, customerId will be used only.

customerCodenullable string

User-generated custom unique code to filter a specific business entity. If customerId is also provided, it will override this filter.

tagNamenullable string

Name of the tag to be included in the filtering. Case sensitive. It should exactly match with the name in the Nuvio Platform.

projectNamenullable string

Name of the project to be included in the filtering. Case sensitive. It should exactly match with the name in the Nuvio Platform.

projectCodenullable string

User generated code of the project to be included in the filtering. Case sensitive. It should exactly match with the code in the Nuvio Platform.

paymentStatusnullable string

Select one of the enum values to filter specific incomes that matches with required payment status.

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataarray of Incomes

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/list-incomes', {
    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",
      "invoiceNumber": "text",
      "invoiceStatus": "text",
      "paymentStatus": "text",
      "description": "text",
      "dueDate": "text",
      "invoiceDate": "text",
      "currency": "text",
      "exchangeRate": 0,
      "project": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "projectCode": "text"
      },
      "customer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "entityCode": "text"
      },
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "subTotal": 0,
      "totalTax": 0,
      "totalAmount": 0,
      "remainingAmount": 0,
      "items": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "productCode": "text",
          "productId": "123e4567-e89b-12d3-a456-426614174000",
          "productName": "text",
          "unitPrice": "text",
          "totalTaxes": 0,
          "totalAmount": 0,
          "itemTaxes": [
            {
              "taxId": "123e4567-e89b-12d3-a456-426614174000",
              "taxName": "text",
              "taxAmount": 0
            }
          ]
        }
      ],
      "matchedPayments": [
        {
          "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
          "bankAccountName": "text",
          "transactionId": "123e4567-e89b-12d3-a456-426614174000",
          "amount": 0,
          "currency": "text",
          "description": "text",
          "transactionDate": "text"
        }
      ]
    }
  ]
}

Get an Income by ID

Retrieves an income by its unique UID or user-generated Invoice ID

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

Path parameters

id*string

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataIncome

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceNumber": "text",
    "invoiceStatus": "text",
    "paymentStatus": "text",
    "description": "text",
    "dueDate": "text",
    "invoiceDate": "text",
    "currency": "text",
    "exchangeRate": 0,
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "projectCode": "text"
    },
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "entityCode": "text"
    },
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      }
    ],
    "subTotal": 0,
    "totalTax": 0,
    "totalAmount": 0,
    "remainingAmount": 0,
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productCode": "text",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "productName": "text",
        "unitPrice": "text",
        "totalTaxes": 0,
        "totalAmount": 0,
        "itemTaxes": [
          {
            "taxId": "123e4567-e89b-12d3-a456-426614174000",
            "taxName": "text",
            "taxAmount": 0
          }
        ]
      }
    ],
    "matchedPayments": [
      {
        "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
        "bankAccountName": "text",
        "transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 0,
        "currency": "text",
        "description": "text",
        "transactionDate": "text"
      }
    ]
  }
}

WRITE Scope

Create a new Income

Creates a new income from scratch

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

Body

application/jsontext/jsonapplication/*+json

invoiceNumberstring

Invoice number formatted in string. Accepts alpha numeric characters and '-' symbol.

description*string

Description of the income. This will also be its title in the Nuvio Platform.

invoiceDate*string

The date of the income. Should be formatted in YYYY-MM-DD format.

dueDate*string

Due date of the payment for this income. Should be formatted in YYYY-MM-DD format.

currencystring

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

projectIdstring (uuid)

32-character unique ID of the related project. If you don't know the ID, you can also provide projectCode instead of this field. If both of them are provided projectId will be used only.

projectCodestring

User-generated custom code of the related project. If projectId is also provided, it will override this field.

customerIdstring (uuid)

32-character unique ID of the customer. If you don't know the ID, you can also provide customerCode instead of this field. If both of them are provided, customerId will be used only.

customerCodestring

User-generated custom unique code of the specific customer. If customerId is also provided, it will override this field.

tagsarray of string (uuid)

List of the tags that are related to this income. Provide a list of tags with their 32-character unique ID.

itemsarray of CreateIncomeItemsRequest (object)

List of the items that are sold in this income.

exchangeRatenumber (double)

If currency is different than your company's functional currency, this will be the exchange rate that Nuvio will use while converting the amounts of this expense to company's functional currency. Should be number with 4 decimal points. eg. 32.4325

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataIncome

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceNumber": "text",
    "invoiceStatus": "text",
    "paymentStatus": "text",
    "description": "text",
    "dueDate": "text",
    "invoiceDate": "text",
    "currency": "text",
    "exchangeRate": 0,
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "projectCode": "text"
    },
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "entityCode": "text"
    },
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      }
    ],
    "subTotal": 0,
    "totalTax": 0,
    "totalAmount": 0,
    "remainingAmount": 0,
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productCode": "text",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "productName": "text",
        "unitPrice": 0,
        "totalTaxes": 0,
        "totalAmount": 0,
        "itemTaxes": [
          {
            "taxId": "123e4567-e89b-12d3-a456-426614174000",
            "taxName": "text",
            "taxAmount": 0
          }
        ]
      }
    ],
    "matchedPayments": [
      {
        "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
        "bankAccountName": "text",
        "transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 0,
        "currency": "text",
        "description": "text",
        "transactionDate": "text"
      }
    ]
  }
}

UPDATE Scope

Update income

Updates an existing income

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

Path parameters

id*string (uuid)

Body

application/jsontext/jsonapplication/*+json

invoiceNumberstring

Invoice number formatted in string. Accepts alpha numeric characters and '-' symbol.

descriptionstring

Description of the income. This will also be its title in the Nuvio Platform.

invoiceDatestring

The date of the income. Should be formatted in YYYY-MM-DD format

dueDatestring

Due date of the payment for this income. Should be formatted in YYYY-MM-DD format

currencystring

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

projectIdstring (uuid)

32-character unique ID of the related project. If you don't know the ID, you can also provide projectCode instead of this field. If both of them are provided projectId will be used only.

projectCodestring

User-generated custom code of the related project. If projectId is also provided, it will override this field.

customerIdstring (uuid)

32-character unique ID of the customer. If you don't know the ID, you can also provide customerCode instead of this field. If both of them are provided, customerId will be used only.

customerCodestring

User-generated custom unique code of the specific customer. If customerId is also provided, it will override this field.

tagsarray of string (uuid)

List of the tags that are related to this income. Provide a list of tags with their 32-character unique ID.

itemsarray of UpdateIncomeItemsRequest (object)

List of the items that are sold in this income. This list will override existing list of items in the updated income. Do not just update 1 item, make sure to include all the items in your request.

exchangeRatenullable number (double)

If currency is different than your company's functional currency, this will be the exchange rate that Nuvio will use while converting the amounts of this expense to company's functional currency. Should be number with 4 decimal points. eg. 32.4325

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataIncome

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/income/{id}', {
    method: 'PUT',
    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",
    "invoiceNumber": "text",
    "invoiceStatus": "text",
    "paymentStatus": "text",
    "description": "text",
    "dueDate": "text",
    "invoiceDate": "text",
    "currency": "text",
    "exchangeRate": 0,
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "projectCode": "text"
    },
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "entityCode": "text"
    },
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      }
    ],
    "subTotal": 0,
    "totalTax": 0,
    "totalAmount": 0,
    "remainingAmount": 0,
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productCode": "text",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "productName": "text",
        "unitPrice": 0,
        "totalTaxes": 0,
        "totalAmount": 0,
        "itemTaxes": [
          {
            "taxId": "123e4567-e89b-12d3-a456-426614174000",
            "taxName": "text",
            "taxAmount": 0
          }
        ]
      }
    ],
    "matchedPayments": [
      {
        "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
        "bankAccountName": "text",
        "transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 0,
        "currency": "text",
        "description": "text",
        "transactionDate": "text"
      }
    ]
  }
}