Invoice Resource¶
Get Invoice¶
HTTP Request
GET /api/invoice/{id}
📋 Description: Retrieves detailed information about a specific invoice identified by its unique ID, enabling users to access financial records and transaction history for effective account 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 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "invoiceDate": "2019-08-24",
7 "invoiceName": "string",
8 "tax": 0,
9 "invoiceStatusId": 0,
10 "invoiceStatusName": "string",
11 "invoiceStatusType": "string",
12 "invoiceItemIds": [
13 0
14 ],
15 "documentIds": [
16 0
17 ],
18 "workOrderId": 0,
19 "workOrderDisplayId": "string",
20 "totalAmount": 0,
21 "vendorName": "string",
22 "premiseId": 0,
23 "premiseDisplayId": "string",
24 "vendorDisplayId": "string"
25}
Update Invoice¶
HTTP Request
PUT /api/invoice/{id}
📋 Description: Updates the details of a specific invoice identified by its unique ID, allowing businesses to maintain accurate financial records and ensure timely billing adjustments.
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 details, including line items, amounts, and payment status, to ensure accurate billing and financial records. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "invoiceDate": "2019-08-24",
7 "invoiceName": "string",
8 "tax": 0,
9 "invoiceStatusId": 0,
10 "invoiceStatusName": "string",
11 "invoiceStatusType": "string",
12 "invoiceItemIds": [
13 0
14 ],
15 "documentIds": [
16 0
17 ],
18 "workOrderId": 0,
19 "workOrderDisplayId": "string",
20 "totalAmount": 0,
21 "vendorName": "string",
22 "premiseId": 0,
23 "premiseDisplayId": "string",
24 "vendorDisplayId": "string"
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Invoice¶
HTTP Request
DELETE /api/invoice/{id}
📋 Description: Deletes the specified invoice identified by its unique ID, ensuring the removal of any associated financial records from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Update Invoice Status¶
HTTP Request
PUT /api/invoice/{id}/status
📋 Description: Updates the status of a specified invoice, allowing businesses to manage their invoicing process efficiently and ensure accurate financial tracking.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
object |
true |
Request body containing the updated status information for the specified invoice, including relevant metadata to facilitate accurate processing and tracking. |
» additionalProperties |
body |
object |
false |
none |
Body Parameters
1{
2 "property1": {},
3 "property2": {}
4}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "invoiceDate": "2019-08-24",
7 "invoiceName": "string",
8 "tax": 0,
9 "invoiceStatusId": 0,
10 "invoiceStatusName": "string",
11 "invoiceStatusType": "string",
12 "invoiceItemIds": [
13 0
14 ],
15 "documentIds": [
16 0
17 ],
18 "workOrderId": 0,
19 "workOrderDisplayId": "string",
20 "totalAmount": 0,
21 "vendorName": "string",
22 "premiseId": 0,
23 "premiseDisplayId": "string",
24 "vendorDisplayId": "string"
25}
Get All Invoice¶
HTTP Request
GET /api/invoice
📋 Description: Fetches a list of invoices, allowing users to view and manage their billing records efficiently.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "invoiceDate": "2019-08-24",
8 "invoiceName": "string",
9 "tax": 0,
10 "invoiceStatusId": 0,
11 "invoiceStatusName": "string",
12 "invoiceStatusType": "string",
13 "invoiceItemIds": [
14 0
15 ],
16 "documentIds": [
17 0
18 ],
19 "workOrderId": 0,
20 "workOrderDisplayId": "string",
21 "totalAmount": 0,
22 "vendorName": "string",
23 "premiseId": 0,
24 "premiseDisplayId": "string",
25 "vendorDisplayId": "string"
26 }
27]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an invoice, encapsulating essential details such as amounts, dates, and customer information to facilitate efficient billing and financial tracking.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» invoiceDate |
string(date) |
false |
none |
Date of the invoice |
» invoiceName |
string |
false |
none |
Name of the invoice |
» tax |
number |
true |
none |
Represents the total tax amount applicable to the invoice, ensuring accurate financial reporting and compliance. |
» invoiceStatusId |
integer(int64) |
false |
none |
Unique identifier for the invoice status |
» invoiceStatusName |
string |
false |
none |
Name of the invoice status |
» invoiceStatusType |
string |
false |
none |
Type of the invoice status |
» invoiceItemIds |
[integer] |
false |
none |
Array of unique identifiers for individual invoice items associated with the invoice, facilitating precise tracking and management of billing details. |
» documentIds |
[integer] |
false |
none |
Array of unique identifiers for the invoices associated with the transaction, enabling efficient tracking and management of financial documents. |
» workOrderId |
integer(int64) |
false |
none |
Unique identifier for the work order |
» workOrderDisplayId |
string |
false |
none |
Unique identifier for the work order display |
» totalAmount |
number |
false |
none |
Amount of total |
» vendorName |
string |
false |
none |
Name of the vendor |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» vendorDisplayId |
string |
false |
none |
Unique identifier for the vendor display |
Create Invoice¶
HTTP Request
POST /api/invoice
📋 Description: Creates a new invoice in the system, allowing businesses to efficiently manage billing and payment processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the invoice details, including customer information, itemized charges, and payment terms for processing billing transactions. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "invoiceDate": "2019-08-24",
7 "invoiceName": "string",
8 "tax": 0,
9 "invoiceStatusId": 0,
10 "invoiceStatusName": "string",
11 "invoiceStatusType": "string",
12 "invoiceItemIds": [
13 0
14 ],
15 "documentIds": [
16 0
17 ],
18 "workOrderId": 0,
19 "workOrderDisplayId": "string",
20 "totalAmount": 0,
21 "vendorName": "string",
22 "premiseId": 0,
23 "premiseDisplayId": "string",
24 "vendorDisplayId": "string"
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "invoiceDate": "2019-08-24",
7 "invoiceName": "string",
8 "tax": 0,
9 "invoiceStatusId": 0,
10 "invoiceStatusName": "string",
11 "invoiceStatusType": "string",
12 "invoiceItemIds": [
13 0
14 ],
15 "documentIds": [
16 0
17 ],
18 "workOrderId": 0,
19 "workOrderDisplayId": "string",
20 "totalAmount": 0,
21 "vendorName": "string",
22 "premiseId": 0,
23 "premiseDisplayId": "string",
24 "vendorDisplayId": "string"
25}
Search Invoices¶
HTTP Request
POST /api/invoice/search
📋 Description: Submits a request to search for invoices based on specified criteria, enabling users to efficiently locate and manage financial documents.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results for invoices should be returned in a paginated format, enhancing the user experience by allowing for manageable data retrieval. |
|
body |
body |
true |
Request body containing the search criteria and filters for retrieving invoice records based on specified parameters. |
Body Parameters
1{
2 "displayIdLike": "string",
3 "invoiceNameLike": "string",
4 "statusId": 0,
5 "workOrderId": 0,
6 "workOrderDisplayId": "string",
7 "vendorId": 0,
8 "vendorName": "string",
9 "premiseId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "paged": true,
6 "unpaged": true,
7 "pageNumber": 0,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "first": true,
18 "last": true,
19 "size": 0,
20 "content": [
21 {
22 "id": 0,
23 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "displayId": "string",
26 "invoiceDate": "2019-08-24",
27 "invoiceName": "string",
28 "tax": 0,
29 "invoiceStatusId": 0,
30 "invoiceStatusName": "string",
31 "invoiceStatusType": "string",
32 "invoiceItemIds": [
33 0
34 ],
35 "documentIds": [
36 0
37 ],
38 "workOrderId": 0,
39 "workOrderDisplayId": "string",
40 "totalAmount": 0,
41 "vendorName": "string",
42 "premiseId": 0,
43 "premiseDisplayId": "string",
44 "vendorDisplayId": "string"
45 }
46 ],
47 "number": 0,
48 "sort": {
49 "unsorted": true,
50 "sorted": true,
51 "empty": true
52 },
53 "empty": true
54}
Get Invoices By Work Order ID¶
HTTP Request
GET /api/invoice/workOrder/{entityId}
📋 Description: Retrieves the work order details associated with a specific entity, providing essential information for invoice processing and management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entityId |
path |
integer(int64) |
true |
Unique identifier for the entity |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "invoiceDate": "2019-08-24",
8 "invoiceName": "string",
9 "tax": 0,
10 "invoiceStatusId": 0,
11 "invoiceStatusName": "string",
12 "invoiceStatusType": "string",
13 "invoiceItemIds": [
14 0
15 ],
16 "documentIds": [
17 0
18 ],
19 "workOrderId": 0,
20 "workOrderDisplayId": "string",
21 "totalAmount": 0,
22 "vendorName": "string",
23 "premiseId": 0,
24 "premiseDisplayId": "string",
25 "vendorDisplayId": "string"
26 }
27]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an invoice, encapsulating essential details such as amounts, dates, and customer information to facilitate efficient billing and financial tracking.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» invoiceDate |
string(date) |
false |
none |
Date of the invoice |
» invoiceName |
string |
false |
none |
Name of the invoice |
» tax |
number |
true |
none |
Represents the total tax amount applicable to the invoice, ensuring accurate financial reporting and compliance. |
» invoiceStatusId |
integer(int64) |
false |
none |
Unique identifier for the invoice status |
» invoiceStatusName |
string |
false |
none |
Name of the invoice status |
» invoiceStatusType |
string |
false |
none |
Type of the invoice status |
» invoiceItemIds |
[integer] |
false |
none |
Array of unique identifiers for individual invoice items associated with the invoice, facilitating precise tracking and management of billing details. |
» documentIds |
[integer] |
false |
none |
Array of unique identifiers for the invoices associated with the transaction, enabling efficient tracking and management of financial documents. |
» workOrderId |
integer(int64) |
false |
none |
Unique identifier for the work order |
» workOrderDisplayId |
string |
false |
none |
Unique identifier for the work order display |
» totalAmount |
number |
false |
none |
Amount of total |
» vendorName |
string |
false |
none |
Name of the vendor |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» vendorDisplayId |
string |
false |
none |
Unique identifier for the vendor display |
Delete Invoice Item¶
HTTP Request
DELETE /api/invoice/deleteInvoiceItem/{id}
📋 Description: Deletes a specific invoice item identified by the provided ID, ensuring accurate invoice management and maintaining data integrity within the invoicing system.
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 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "invoiceDate": "2019-08-24",
7 "invoiceName": "string",
8 "tax": 0,
9 "invoiceStatusId": 0,
10 "invoiceStatusName": "string",
11 "invoiceStatusType": "string",
12 "invoiceItemIds": [
13 0
14 ],
15 "documentIds": [
16 0
17 ],
18 "workOrderId": 0,
19 "workOrderDisplayId": "string",
20 "totalAmount": 0,
21 "vendorName": "string",
22 "premiseId": 0,
23 "premiseDisplayId": "string",
24 "vendorDisplayId": "string"
25}