Income

All API Operations related with Income

PreviousExpenses NextPayments

Last updated 6 months ago

List all incomes

Retrieves all the incomes that match with provided filters

post

/v1/list-incomes

Authorizations

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.nuvio.io/v1/list-incomes' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "text",
    "endDate": "text",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "customerCode": "text",
    "tagName": "text",
    "projectName": "text",
    "projectCode": "text",
    "paymentStatus": "text"
  }'

200

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceNumber": "text",
      "invoiceStatus": "text",
      "paymentStatus": "text",
      "description": "text",
      "dueDate": "text",
      "invoiceDate": "text",
      "currency": "text",
      "exchangeRate": 1,
      "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": 1,
      "totalTax": 1,
      "totalAmount": 1,
      "remainingAmount": 1,
      "items": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "productCode": "text",
          "productId": "123e4567-e89b-12d3-a456-426614174000",
          "productName": "text",
          "quantity": 1,
          "unitPrice": "text",
          "totalTaxes": 1,
          "totalAmount": 1,
          "itemTaxes": [
            {
              "taxId": "123e4567-e89b-12d3-a456-426614174000",
              "taxName": "text",
              "taxAmount": 1
            }
          ]
        }
      ],
      "matchedPayments": [
        {
          "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
          "bankAccountName": "text",
          "transactionId": "123e4567-e89b-12d3-a456-426614174000",
          "amount": 1,
          "currency": "text",
          "description": "text",
          "transactionDate": "text"
        }
      ]
    }
  ]
}

Get an Income by ID

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

get

/v1/income/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.nuvio.io/v1/income/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceNumber": "text",
    "invoiceStatus": "text",
    "paymentStatus": "text",
    "description": "text",
    "dueDate": "text",
    "invoiceDate": "text",
    "currency": "text",
    "exchangeRate": 1,
    "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": 1,
    "totalTax": 1,
    "totalAmount": 1,
    "remainingAmount": 1,
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productCode": "text",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "productName": "text",
        "quantity": 1,
        "unitPrice": "text",
        "totalTaxes": 1,
        "totalAmount": 1,
        "itemTaxes": [
          {
            "taxId": "123e4567-e89b-12d3-a456-426614174000",
            "taxName": "text",
            "taxAmount": 1
          }
        ]
      }
    ],
    "matchedPayments": [
      {
        "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
        "bankAccountName": "text",
        "transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 1,
        "currency": "text",
        "description": "text",
        "transactionDate": "text"
      }
    ]
  }
}

Create a new Income

Creates a new income from scratch

post

/v1/income

Authorizations

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.nuvio.io/v1/income' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "invoiceNumber": "text",
    "description": "text",
    "invoiceDate": "text",
    "dueDate": "text",
    "currency": "text",
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "projectCode": "text",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "customerCode": "text",
    "tags": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "items": [
      {
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "productCode": "text",
        "quantity": 1,
        "itemTaxes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "unitPrice": 1
      }
    ],
    "exchangeRate": 1
  }'

200

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceNumber": "text",
    "invoiceStatus": "text",
    "paymentStatus": "text",
    "description": "text",
    "dueDate": "text",
    "invoiceDate": "text",
    "currency": "text",
    "exchangeRate": 1,
    "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": 1,
    "totalTax": 1,
    "totalAmount": 1,
    "remainingAmount": 1,
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productCode": "text",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "productName": "text",
        "quantity": 1,
        "unitPrice": 1,
        "totalTaxes": 1,
        "totalAmount": 1,
        "itemTaxes": [
          {
            "taxId": "123e4567-e89b-12d3-a456-426614174000",
            "taxName": "text",
            "taxAmount": 1
          }
        ]
      }
    ],
    "matchedPayments": [
      {
        "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
        "bankAccountName": "text",
        "transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 1,
        "currency": "text",
        "description": "text",
        "transactionDate": "text"
      }
    ]
  }
}

Update income

Updates an existing income

put

/v1/income/{id}

Authorizations

Path parameters

idstring · uuidrequired

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.nuvio.io/v1/income/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "invoiceNumber": "text",
    "description": "text",
    "invoiceDate": "text",
    "dueDate": "text",
    "currency": "text",
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "projectCode": "text",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "customerCode": "text",
    "tags": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "items": [
      {
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "productCode": "text",
        "quantity": 1,
        "itemTaxes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "unitPrice": 1
      }
    ],
    "exchangeRate": 1
  }'

200

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceNumber": "text",
    "invoiceStatus": "text",
    "paymentStatus": "text",
    "description": "text",
    "dueDate": "text",
    "invoiceDate": "text",
    "currency": "text",
    "exchangeRate": 1,
    "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": 1,
    "totalTax": 1,
    "totalAmount": 1,
    "remainingAmount": 1,
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productCode": "text",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "productName": "text",
        "quantity": 1,
        "unitPrice": 1,
        "totalTaxes": 1,
        "totalAmount": 1,
        "itemTaxes": [
          {
            "taxId": "123e4567-e89b-12d3-a456-426614174000",
            "taxName": "text",
            "taxAmount": 1
          }
        ]
      }
    ],
    "matchedPayments": [
      {
        "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
        "bankAccountName": "text",
        "transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 1,
        "currency": "text",
        "description": "text",
        "transactionDate": "text"
      }
    ]
  }
}

Income

Income

READ Scope

WRITE Scope

UPDATE Scope

READ Scope

WRITE Scope

UPDATE Scope

List all incomes

Get an Income by ID

Create a new Income

Update income

READ Scope

WRITE Scope

UPDATE Scope

READ Scope

WRITE Scope

UPDATE Scope

List all incomes

Show child attributes

Get an Income by ID

Create a new Income

Show child attributes

Update income

Show child attributes