Developers
API ReferenceIncome

Updates the Income resource.

PATCH
/finance/incomes/{id}

Updates the Income resource.

Authorization

apiKey
Authorization<token>

Value for the Authorization header parameter.

In: header

Path Parameters

id*string

Income identifier

Query Parameters

priceNet[gt]?

Income priceNet

priceNet[gte]?

Income priceNet

priceNet[lt]?

Income priceNet

priceNet[lte]?

Income priceNet

priceNet[ne]?

Income priceNet

priceGross[gt]?

Income priceGross

priceGross[gte]?

Income priceGross

priceGross[lt]?

Income priceGross

priceGross[lte]?

Income priceGross

priceGross[ne]?

Income priceGross

Request Body

The updated Income resource

TypeScript Definitions

Use the request body type in TypeScript.

name?string
Lengthlength <= 100
description?|
Lengthlength <= 100
priceNet?number
Formatfloat
Default0
priceGross?number
Formatfloat
Default0
date?string
Formatdate-time
dateDeadline?|
Formatdate-time
isBilled?boolean
Defaultfalse
isPosted?boolean
Defaultfalse
incomeCategory?string
Formatuuid
taxRate?string
Formatuuid
financeContractor?|
Formatuuid
financeProject?|
Formatuuid
financeStage?|
Formatuuid
financeBoard?|
Formatuuid
financeTask?|
Formatuuid
invoice?|
Formatuuid

Response Body

curl -X PATCH "https://example.com/finance/incomes/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "priceNet": 0.1,  "priceGross": 0.1,  "isBilled": true,  "isPosted": true,  "incomeType": "manually",  "date": "2019-08-24T14:15:22Z",  "dateDeadline": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "createdBy": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "shortCode": "string",    "firstName": "string",    "lastName": "string",    "email": "string",    "phoneNumber": "string",    "pictureSm": "string",    "pictureLg": "string",    "canLogIn": false,    "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",    "contractorName": "string",    "jobPositionName": "string"  },  "incomeCategory": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "createdBy": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "shortCode": "string",      "firstName": "string",      "lastName": "string",      "email": "string",      "phoneNumber": "string",      "pictureSm": "string",      "pictureLg": "string",      "canLogIn": false,      "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",      "contractorName": "string",      "jobPositionName": "string"    }  },  "financeContractor": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "pictureSm": "string"  },  "taxRate": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "value": 0.1,    "isDefault": false  },  "financeProject": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "shortCode": "string",    "no": "string",    "isSimple": true  },  "financeStage": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "financeProject": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "shortCode": "string",      "no": "string",      "isSimple": true    }  },  "financeBoard": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "shortCode": "string",    "financeProject": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "shortCode": "string",      "no": "string",      "isSimple": true    },    "financeStage": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "financeProject": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "shortCode": "string",        "no": "string",        "isSimple": true      }    }  },  "financeTask": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "number": 0,    "shortCode": "string",    "financeProject": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "shortCode": "string",      "no": "string",      "isSimple": true    },    "financeStage": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "financeProject": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "shortCode": "string",        "no": "string",        "isSimple": true      }    },    "financeBoard": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "shortCode": "string",      "financeProject": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "shortCode": "string",        "no": "string",        "isSimple": true      },      "financeStage": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "financeProject": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "shortCode": "string",          "no": "string",          "isSimple": true        }      }    }  },  "invoice": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "no": "string",    "docTitle": "string",    "saleDate": "2019-08-24T14:15:22Z",    "issueDate": "2019-08-24T14:15:22Z",    "deadlineDate": "2019-08-24T14:15:22Z",    "issuedPlace": "string",    "invoiceType": "fv",    "sellerName": "string",    "sellerVatId": "string",    "sellerStreet": "string",    "sellerZipCode": "string",    "sellerCity": "string",    "sellerCreatorName": "string",    "buyerId": "7925fb6c-1391-458a-9144-275078d9f24b",    "buyerContractorName": "string",    "buyerName": "string",    "buyerVatId": "string",    "buyerStreet": "string",    "buyerZipCode": "string",    "buyerCity": "string",    "bankAccount": "string",    "currencyCode": "str",    "paymentMethod": "cash",    "alreadyPaid": 0,    "toPay": 0,    "netAmount": 0,    "vatAmount": 0,    "grossAmount": 0,    "description": "string",    "posted": false,    "createdBy": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "shortCode": "string",      "firstName": "string",      "lastName": "string",      "email": "string",      "phoneNumber": "string",      "pictureSm": "string",      "pictureLg": "string",      "canLogIn": false,      "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",      "contractorName": "string",      "jobPositionName": "string"    },    "createdAt": "2019-08-24T14:15:22Z",    "isUpdated": false,    "updatedBy": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "shortCode": "string",      "firstName": "string",      "lastName": "string",      "email": "string",      "phoneNumber": "string",      "pictureSm": "string",      "pictureLg": "string",      "canLogIn": false,      "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",      "contractorName": "string",      "jobPositionName": "string"    },    "updatedAt": "2019-08-24T14:15:22Z",    "items": [      {        "order": 0,        "positionName": "string",        "unit": "string",        "count": 0,        "priceUnit": 0,        "tax": "string",        "netAmount": 0,        "vatAmount": 0,        "grossAmount": 0,        "gtu": "string"      }    ],    "numbering": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "fv",      "pattern": "string",      "resetInterval": "P1M",      "leadingZero": 0,      "isDefault": true,      "docTitle": "string",      "closestCounter": null    },    "financeProject": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "shortCode": "string",      "no": "string",      "isSimple": true    }  },  "incomeFiles": [    {      "createdBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "firstName": "string",        "lastName": "string",        "email": "string",        "pictureSm": "string",        "contractorName": "string",        "jobPositionName": "string"      },      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "displayedName": "string",      "extension": "string",      "size": 0,      "source": "internal",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}

Retrieves a Income resource.GET

Previous Page

Removes the Income resource.DELETE

Next Page