Income

All API Operations related with Income

READ Scope

List all incomes

post

Retrieves all the incomes that match with provided filters

Authorizations

Body

application/jsontext/jsonapplication/*+json

all ofOptional

Responses

post

HTTPcURLJavaScriptPython

POST /v1/list-incomes HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "startDate": "text",
  "endDate": "text",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerCode": "text",
  "tagName": "text",
  "projectName": "text",
  "projectCode": "text",
  "paymentStatus": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "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

get

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

Authorizations

Path parameters

idstringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /v1/income/{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",
    "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"
      }
    ]
  }
}

WRITE Scope

Create a new Income

post

Creates a new income from scratch

Authorizations

Body

application/jsontext/jsonapplication/*+json

all ofOptional

Responses

post

HTTPcURLJavaScriptPython

POST /v1/income HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 476

{
  "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
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "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 Scope

Update income

put

Updates an existing income

Authorizations

Path parameters

idstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

all ofOptional

Responses

put

HTTPcURLJavaScriptPython

PUT /v1/income/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 476

{
  "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
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "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"
      }
    ]
  }
}