Invoice Status Resource¶
Get Invoice Status¶
HTTP Request
GET /api/invoiceStatuses/{id}
📋 Description: Retrieves the details of a specific invoice status by its unique identifier, enabling users to track and manage invoice progress efficiently.
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 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "invoiceStatusType": "string",
10 "isDefaultType": true
11}
Update Invoice Status¶
HTTP Request
PUT /api/invoiceStatuses/{id}
📋 Description: Updates the status of a specified invoice, allowing businesses to reflect changes in payment or processing status efficiently.
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 status information, including the new status and any relevant metadata for processing. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "invoiceStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Get All Invoice Statuses¶
HTTP Request
GET /api/invoiceStatuses
📋 Description: Retrieves the current statuses of invoices, providing users with an overview of invoice processing stages to enhance financial tracking and management.
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 "name": "string",
8 "isDefault": true,
9 "objectAvailable": true,
10 "invoiceStatusType": "string",
11 "isDefaultType": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the status of an invoice, including relevant metadata to facilitate tracking and management within financial operations.] |
|
» 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 |
» name |
string |
true |
none |
Name of the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» objectAvailable |
boolean |
false |
none |
Indicates whether the invoice is currently available for processing or review within the system. |
» invoiceStatusType |
string |
false |
none |
Type of the invoice status |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Create Invoice Status¶
HTTP Request
POST /api/invoiceStatuses
📋 Description: Creates a new invoice status entry, allowing businesses to manage and track the progress of invoices efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the invoice status details, including status identifiers and associated metadata for processing and tracking purposes. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "invoiceStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get All Invoice Status Type¶
HTTP Request
GET /api/invoiceStatuses/invoiceStatusType
📋 Description: Retrieves the available invoice status types, providing essential information for managing and tracking invoice processing within your financial operations.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "DRAFT"
3]
Response Schema
Get All Invoice Statuses By User¶
HTTP Request
GET /api/invoiceStatuses/allInvoiceStatuses
📋 Description: Retrieves a comprehensive list of all invoice statuses available in the system, enabling users to effectively manage and track invoice processing.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "property1": {},
3 "property2": {}
4}
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» additionalProperties |
object |
false |
none |
none |