| Requires any of the roles: | Worker, Agent, Administrator |
| GET,OPTIONS | /v1/invoice/{InvoiceUID} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceUID | path | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| InvoiceData | form | InvoiceData | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Invoice | form | Invoice | No | |
| LineItems | form | List<InvoiceLineItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceID | form | int | No | |
| InvoiceUID | form | Guid? | No | |
| ProjectUID | form | Guid? | No | |
| InvoiceNumber | form | string | No | |
| InvoiceDate | form | DateTime? | No | |
| DueDate | form | DateTime? | No | |
| FromName | form | string | No | |
| FromPhone | form | string | No | |
| FromEmail | form | string | No | |
| FromAddress | form | string | No | |
| FromDesc | form | string | No | |
| ToName | form | string | No | |
| ToPhone | form | string | No | |
| ToEmail | form | string | No | |
| ToAddress | form | string | No | |
| ToDesc | form | string | No | |
| Notes | form | string | No | |
| Currency | form | string | No | |
| Status | form | int | No | |
| Total | form | decimal? | No | |
| IsPaid | form | bool? | No | |
| PaidDate | form | DateTime? | No | |
| IsDeleted | form | bool? | No | |
| IsLocked | form | bool? | No | |
| CreatedDate | form | DateTime? | No | |
| ModifiedDate | form | DateTime? | No | |
| CreatedByUID | form | Guid? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceLineItemID | form | int | No | |
| InvoiceID | form | int | No | |
| Type | form | string | No | |
| Name | form | string | No | |
| Quantity | form | int? | No | |
| PercentageAdjust | form | decimal? | No | |
| AmountAdjust | form | decimal? | No | |
| Price | form | decimal? | No | |
| Description | form | string | No | |
| Notes | form | string | No | |
| IsTaxable | form | bool? | No | |
| DisplayOrder | form | int? | No | |
| IsLocked | form | bool? | No | |
| IsDeleted | form | bool? | No | |
| IsPaid | form | bool? | No | |
| CreatedDate | form | DateTime? | No | |
| ModifiedDate | form | DateTime? | No | |
| CreatedByUID | form | Guid? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/invoice/{InvoiceUID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
InvoiceData:
{
Invoice:
{
InvoiceID: 0,
InvoiceUID: 00000000000000000000000000000000,
ProjectUID: 00000000000000000000000000000000,
InvoiceNumber: String,
InvoiceDate: 0001-01-01,
DueDate: 0001-01-01,
FromName: String,
FromPhone: String,
FromEmail: String,
FromAddress: String,
FromDesc: String,
ToName: String,
ToPhone: String,
ToEmail: String,
ToAddress: String,
ToDesc: String,
Notes: String,
Currency: String,
Status: 0,
Total: 0,
IsPaid: False,
PaidDate: 0001-01-01,
IsDeleted: False,
IsLocked: False,
CreatedDate: 0001-01-01,
ModifiedDate: 0001-01-01,
CreatedByUID: 00000000000000000000000000000000
},
LineItems:
[
{
InvoiceLineItemID: 0,
InvoiceID: 0,
Type: String,
Name: String,
Quantity: 0,
PercentageAdjust: 0,
AmountAdjust: 0,
Price: 0,
Description: String,
Notes: String,
IsTaxable: False,
DisplayOrder: 0,
IsLocked: False,
IsDeleted: False,
IsPaid: False,
CreatedDate: 0001-01-01,
ModifiedDate: 0001-01-01,
CreatedByUID: 00000000000000000000000000000000
}
]
}
}