Trendsic Platform Service

<back to all web services

InsertInvoiceRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/invoice
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

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 InsertInvoiceRequest implements IConvertible
{
    Invoice? Invoice;
    List<InvoiceLineItem>? LineItems = [];

    InsertInvoiceRequest({this.Invoice,this.LineItems});
    InsertInvoiceRequest.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() => "InsertInvoiceRequest";
    TypeContext? context = _ctx;
}

class InvoiceIdentification implements IConvertible
{
    int? InvoiceId;
    String? InvoiceUid;

    InvoiceIdentification({this.InvoiceId,this.InvoiceUid});
    InvoiceIdentification.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        InvoiceId = json['InvoiceId'];
        InvoiceUid = json['InvoiceUid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'InvoiceId': InvoiceId,
        'InvoiceUid': InvoiceUid
    };

    getTypeName() => "InvoiceIdentification";
    TypeContext? context = _ctx;
}

class InsertInvoiceResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    InvoiceIdentification? NewInvoiceIdentification;

    InsertInvoiceResponse({this.ResponseStatus,this.NewInvoiceIdentification});
    InsertInvoiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        NewInvoiceIdentification = JsonConverters.fromJson(json['NewInvoiceIdentification'],'InvoiceIdentification',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'NewInvoiceIdentification': JsonConverters.toJson(NewInvoiceIdentification,'InvoiceIdentification',context!)
    };

    getTypeName() => "InsertInvoiceResponse";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'Invoice': TypeInfo(TypeOf.Class, create:() => Invoice()),
    'InvoiceLineItem': TypeInfo(TypeOf.Class, create:() => InvoiceLineItem()),
    'InsertInvoiceRequest': TypeInfo(TypeOf.Class, create:() => InsertInvoiceRequest()),
    'List<InvoiceLineItem>': TypeInfo(TypeOf.Class, create:() => <InvoiceLineItem>[]),
    'InvoiceIdentification': TypeInfo(TypeOf.Class, create:() => InvoiceIdentification()),
    'InsertInvoiceResponse': TypeInfo(TypeOf.Class, create:() => InsertInvoiceResponse()),
});

Dart InsertInvoiceRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/invoice HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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
		}
	]
}
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
		}
	},
	NewInvoiceIdentification: 
	{
		InvoiceId: 0,
		InvoiceUid: 00000000000000000000000000000000
	}
}