| Requires any of the roles: | Worker, Agent, Administrator |
| GET,OPTIONS | /v1/invoice/{InvoiceUID} |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
class GetInvoiceByUidRequest implements IConvertible
{
String? InvoiceUID;
GetInvoiceByUidRequest({this.InvoiceUID});
GetInvoiceByUidRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
InvoiceUID = json['InvoiceUID'];
return this;
}
Map<String, dynamic> toJson() => {
'InvoiceUID': InvoiceUID
};
getTypeName() => "GetInvoiceByUidRequest";
TypeContext? context = _ctx;
}
class Invoice implements IConvertible
{
int? InvoiceID;
String? InvoiceUID;
String? ProjectUID;
String? InvoiceNumber;
DateTime? InvoiceDate;
DateTime? DueDate;
String? FromName;
String? FromPhone;
String? FromEmail;
String? FromAddress;
String? FromDesc;
String? ToName;
String? ToPhone;
String? ToEmail;
String? ToAddress;
String? ToDesc;
String? Notes;
String? Currency;
int? Status;
double? Total;
bool? IsPaid;
DateTime? PaidDate;
bool? IsDeleted;
bool? IsLocked;
DateTime? CreatedDate;
DateTime? ModifiedDate;
String? CreatedByUID;
Invoice({this.InvoiceID,this.InvoiceUID,this.ProjectUID,this.InvoiceNumber,this.InvoiceDate,this.DueDate,this.FromName,this.FromPhone,this.FromEmail,this.FromAddress,this.FromDesc,this.ToName,this.ToPhone,this.ToEmail,this.ToAddress,this.ToDesc,this.Notes,this.Currency,this.Status,this.Total,this.IsPaid,this.PaidDate,this.IsDeleted,this.IsLocked,this.CreatedDate,this.ModifiedDate,this.CreatedByUID});
Invoice.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
InvoiceID = json['InvoiceID'];
InvoiceUID = json['InvoiceUID'];
ProjectUID = json['ProjectUID'];
InvoiceNumber = json['InvoiceNumber'];
InvoiceDate = JsonConverters.fromJson(json['InvoiceDate'],'DateTime',context!);
DueDate = JsonConverters.fromJson(json['DueDate'],'DateTime',context!);
FromName = json['FromName'];
FromPhone = json['FromPhone'];
FromEmail = json['FromEmail'];
FromAddress = json['FromAddress'];
FromDesc = json['FromDesc'];
ToName = json['ToName'];
ToPhone = json['ToPhone'];
ToEmail = json['ToEmail'];
ToAddress = json['ToAddress'];
ToDesc = json['ToDesc'];
Notes = json['Notes'];
Currency = json['Currency'];
Status = json['Status'];
Total = JsonConverters.toDouble(json['Total']);
IsPaid = json['IsPaid'];
PaidDate = JsonConverters.fromJson(json['PaidDate'],'DateTime',context!);
IsDeleted = json['IsDeleted'];
IsLocked = json['IsLocked'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
CreatedByUID = json['CreatedByUID'];
return this;
}
Map<String, dynamic> toJson() => {
'InvoiceID': InvoiceID,
'InvoiceUID': InvoiceUID,
'ProjectUID': ProjectUID,
'InvoiceNumber': InvoiceNumber,
'InvoiceDate': JsonConverters.toJson(InvoiceDate,'DateTime',context!),
'DueDate': JsonConverters.toJson(DueDate,'DateTime',context!),
'FromName': FromName,
'FromPhone': FromPhone,
'FromEmail': FromEmail,
'FromAddress': FromAddress,
'FromDesc': FromDesc,
'ToName': ToName,
'ToPhone': ToPhone,
'ToEmail': ToEmail,
'ToAddress': ToAddress,
'ToDesc': ToDesc,
'Notes': Notes,
'Currency': Currency,
'Status': Status,
'Total': Total,
'IsPaid': IsPaid,
'PaidDate': JsonConverters.toJson(PaidDate,'DateTime',context!),
'IsDeleted': IsDeleted,
'IsLocked': IsLocked,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'CreatedByUID': CreatedByUID
};
getTypeName() => "Invoice";
TypeContext? context = _ctx;
}
class InvoiceLineItem implements IConvertible
{
int? InvoiceLineItemID;
int? InvoiceID;
String? Type;
String? Name;
int? Quantity;
double? PercentageAdjust;
double? AmountAdjust;
double? Price;
String? Description;
String? Notes;
bool? IsTaxable;
int? DisplayOrder;
bool? IsLocked;
bool? IsDeleted;
bool? IsPaid;
DateTime? CreatedDate;
DateTime? ModifiedDate;
String? CreatedByUID;
InvoiceLineItem({this.InvoiceLineItemID,this.InvoiceID,this.Type,this.Name,this.Quantity,this.PercentageAdjust,this.AmountAdjust,this.Price,this.Description,this.Notes,this.IsTaxable,this.DisplayOrder,this.IsLocked,this.IsDeleted,this.IsPaid,this.CreatedDate,this.ModifiedDate,this.CreatedByUID});
InvoiceLineItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
InvoiceLineItemID = json['InvoiceLineItemID'];
InvoiceID = json['InvoiceID'];
Type = json['Type'];
Name = json['Name'];
Quantity = json['Quantity'];
PercentageAdjust = JsonConverters.toDouble(json['PercentageAdjust']);
AmountAdjust = JsonConverters.toDouble(json['AmountAdjust']);
Price = JsonConverters.toDouble(json['Price']);
Description = json['Description'];
Notes = json['Notes'];
IsTaxable = json['IsTaxable'];
DisplayOrder = json['DisplayOrder'];
IsLocked = json['IsLocked'];
IsDeleted = json['IsDeleted'];
IsPaid = json['IsPaid'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
CreatedByUID = json['CreatedByUID'];
return this;
}
Map<String, dynamic> toJson() => {
'InvoiceLineItemID': InvoiceLineItemID,
'InvoiceID': InvoiceID,
'Type': Type,
'Name': Name,
'Quantity': Quantity,
'PercentageAdjust': PercentageAdjust,
'AmountAdjust': AmountAdjust,
'Price': Price,
'Description': Description,
'Notes': Notes,
'IsTaxable': IsTaxable,
'DisplayOrder': DisplayOrder,
'IsLocked': IsLocked,
'IsDeleted': IsDeleted,
'IsPaid': IsPaid,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'CreatedByUID': CreatedByUID
};
getTypeName() => "InvoiceLineItem";
TypeContext? context = _ctx;
}
class InvoiceData implements IConvertible
{
Invoice? Invoice;
List<InvoiceLineItem>? LineItems = [];
InvoiceData({this.Invoice,this.LineItems});
InvoiceData.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Invoice = JsonConverters.fromJson(json['Invoice'],'Invoice',context!);
LineItems = JsonConverters.fromJson(json['LineItems'],'List<InvoiceLineItem>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Invoice': JsonConverters.toJson(Invoice,'Invoice',context!),
'LineItems': JsonConverters.toJson(LineItems,'List<InvoiceLineItem>',context!)
};
getTypeName() => "InvoiceData";
TypeContext? context = _ctx;
}
class GetInvoiceByUidResponse implements IConvertible
{
ResponseStatus? ResponseStatus;
InvoiceData? InvoiceData;
GetInvoiceByUidResponse({this.ResponseStatus,this.InvoiceData});
GetInvoiceByUidResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
InvoiceData = JsonConverters.fromJson(json['InvoiceData'],'InvoiceData',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
'InvoiceData': JsonConverters.toJson(InvoiceData,'InvoiceData',context!)
};
getTypeName() => "GetInvoiceByUidResponse";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
'GetInvoiceByUidRequest': TypeInfo(TypeOf.Class, create:() => GetInvoiceByUidRequest()),
'Invoice': TypeInfo(TypeOf.Class, create:() => Invoice()),
'InvoiceLineItem': TypeInfo(TypeOf.Class, create:() => InvoiceLineItem()),
'InvoiceData': TypeInfo(TypeOf.Class, create:() => InvoiceData()),
'List<InvoiceLineItem>': TypeInfo(TypeOf.Class, create:() => <InvoiceLineItem>[]),
'GetInvoiceByUidResponse': TypeInfo(TypeOf.Class, create:() => GetInvoiceByUidResponse()),
});
Dart GetInvoiceByUidRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetInvoiceByUidResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<InvoiceData>
<Invoice>
<CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Currency>String</Currency>
<DueDate>0001-01-01T00:00:00</DueDate>
<FromAddress>String</FromAddress>
<FromDesc>String</FromDesc>
<FromEmail>String</FromEmail>
<FromName>String</FromName>
<FromPhone>String</FromPhone>
<InvoiceDate>0001-01-01T00:00:00</InvoiceDate>
<InvoiceID>0</InvoiceID>
<InvoiceNumber>String</InvoiceNumber>
<InvoiceUID>00000000-0000-0000-0000-000000000000</InvoiceUID>
<IsDeleted>false</IsDeleted>
<IsLocked>false</IsLocked>
<IsPaid>false</IsPaid>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<Notes>String</Notes>
<PaidDate>0001-01-01T00:00:00</PaidDate>
<ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
<Status>0</Status>
<ToAddress>String</ToAddress>
<ToDesc>String</ToDesc>
<ToEmail>String</ToEmail>
<ToName>String</ToName>
<ToPhone>String</ToPhone>
<Total>0</Total>
</Invoice>
<LineItems>
<InvoiceLineItem>
<AmountAdjust>0</AmountAdjust>
<CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Description>String</Description>
<DisplayOrder>0</DisplayOrder>
<InvoiceID>0</InvoiceID>
<InvoiceLineItemID>0</InvoiceLineItemID>
<IsDeleted>false</IsDeleted>
<IsLocked>false</IsLocked>
<IsPaid>false</IsPaid>
<IsTaxable>false</IsTaxable>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<Name>String</Name>
<Notes>String</Notes>
<PercentageAdjust>0</PercentageAdjust>
<Price>0</Price>
<Quantity>0</Quantity>
<Type>String</Type>
</InvoiceLineItem>
</LineItems>
</InvoiceData>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetInvoiceByUidResponse>