Invoice Item Resource¶
Get Invoice Item¶
HTTP Request
GET /api/invoiceItem/{id}
📋 Description: Retrieves detailed information about a specific invoice item identified by its unique ID, enabling users to access essential billing data for review and management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "description": "string",
4 "times": 0,
5 "labor": 0,
6 "materials": 0,
7 "total": 0,
8 "invoiceId": 0
9}
Update Invoice Item¶
HTTP Request
PUT /api/invoiceItem/{id}
📋 Description: Updates the details of a specific invoice item identified by its unique ID, allowing for adjustments to quantities, pricing, or descriptions to ensure accurate billing and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated invoice item details, including item description, quantity, price, and any applicable adjustments. |
Body Parameters
1{
2 "id": 0,
3 "description": "string",
4 "times": 0,
5 "labor": 0,
6 "materials": 0,
7 "total": 0,
8 "invoiceId": 0
9}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Update Invoice Items¶
HTTP Request
PUT /api/invoiceItem/batch
📋 Description: Updates multiple invoice items in a single request, allowing for efficient batch processing and management of invoicing data.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a batch of invoice item details, including item identifiers, quantities, and pricing information for efficient invoice management. |
Body Parameters
1[
2 {
3 "id": 0,
4 "description": "string",
5 "times": 0,
6 "labor": 0,
7 "materials": 0,
8 "total": 0,
9 "invoiceId": 0
10 }
11]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Create Invoice Items¶
HTTP Request
POST /api/invoiceItem/batch
📋 Description: Submits a batch of invoice items for processing, enabling efficient management of multiple entries in a single request.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a batch of invoice item details, including item descriptions, quantities, and pricing information for streamlined processing and management of invoicing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "description": "string",
5 "times": 0,
6 "labor": 0,
7 "materials": 0,
8 "total": 0,
9 "invoiceId": 0
10 }
11]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Create Invoice Item¶
HTTP Request
POST /api/invoiceItem
📋 Description: Creates a new invoice item within the system, allowing businesses to accurately track and manage billing details associated with their transactions.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the invoice item details, including item description, quantity, unit price, and associated invoice ID for accurate billing and record-keeping. |
Body Parameters
1{
2 "id": 0,
3 "description": "string",
4 "times": 0,
5 "labor": 0,
6 "materials": 0,
7 "total": 0,
8 "invoiceId": 0
9}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "description": "string",
4 "times": 0,
5 "labor": 0,
6 "materials": 0,
7 "total": 0,
8 "invoiceId": 0
9}
Get Invoice Items¶
HTTP Request
GET /api/invoiceItem/list/{invoiceId}
📋 Description: Retrieves a list of invoice items associated with the specified invoice ID, providing detailed insights into individual charges and adjustments for effective financial management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
invoiceId |
path |
integer(int64) |
true |
Unique identifier for the invoice |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "description": "string",
5 "times": 0,
6 "labor": 0,
7 "materials": 0,
8 "total": 0,
9 "invoiceId": 0
10 }
11]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an individual line item within an invoice, detailing the product or service provided, its quantity, price, and any applicable discounts, essential for accurate billing and financial reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» description |
string |
false |
none |
Description of the resource |
» times |
number |
false |
none |
Represents the quantity of items associated with the invoice, essential for accurate billing and inventory management. |
» labor |
number |
false |
none |
Represents the total labor cost associated with the invoice item, facilitating accurate financial tracking and reporting. |
» materials |
number |
false |
none |
Represents the quantity of materials associated with the invoice item, essential for accurate billing and inventory management. |
» total |
number |
false |
none |
Total value |
» invoiceId |
integer(int64) |
false |
none |
Unique identifier for the invoice |