Trendsic Platform Service

<back to all web services

PortalInvoiceRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/invoice
import 'package:servicestack/servicestack.dart';

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 PortalInvoiceResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    String? InvoiceNumber;
    DateTime? InvoiceDate;
    DateTime? DueDate;
    String? FromName;
    String? FromAddress;
    String? ToName;
    String? ToAddress;
    String? Currency;
    double? Total;
    double? AmountPaid;
    double? Balance;
    bool? IsPaid;
    List<InvoiceLineItem>? LineItems = [];

    PortalInvoiceResponse({this.ResponseStatus,this.InvoiceNumber,this.InvoiceDate,this.DueDate,this.FromName,this.FromAddress,this.ToName,this.ToAddress,this.Currency,this.Total,this.AmountPaid,this.Balance,this.IsPaid,this.LineItems});
    PortalInvoiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        InvoiceNumber = json['InvoiceNumber'];
        InvoiceDate = JsonConverters.fromJson(json['InvoiceDate'],'DateTime',context!);
        DueDate = JsonConverters.fromJson(json['DueDate'],'DateTime',context!);
        FromName = json['FromName'];
        FromAddress = json['FromAddress'];
        ToName = json['ToName'];
        ToAddress = json['ToAddress'];
        Currency = json['Currency'];
        Total = JsonConverters.toDouble(json['Total']);
        AmountPaid = JsonConverters.toDouble(json['AmountPaid']);
        Balance = JsonConverters.toDouble(json['Balance']);
        IsPaid = json['IsPaid'];
        LineItems = JsonConverters.fromJson(json['LineItems'],'List<InvoiceLineItem>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'InvoiceNumber': InvoiceNumber,
        'InvoiceDate': JsonConverters.toJson(InvoiceDate,'DateTime',context!),
        'DueDate': JsonConverters.toJson(DueDate,'DateTime',context!),
        'FromName': FromName,
        'FromAddress': FromAddress,
        'ToName': ToName,
        'ToAddress': ToAddress,
        'Currency': Currency,
        'Total': Total,
        'AmountPaid': AmountPaid,
        'Balance': Balance,
        'IsPaid': IsPaid,
        'LineItems': JsonConverters.toJson(LineItems,'List<InvoiceLineItem>',context!)
    };

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

class PortalInvoiceRequest implements IConvertible
{
    String? Token;

    PortalInvoiceRequest({this.Token});
    PortalInvoiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

Dart PortalInvoiceRequest DTOs

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

HTTP + CSV

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

GET /portal/{Token}/invoice HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"InvoiceNumber":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","FromName":"String","FromAddress":"String","ToName":"String","ToAddress":"String","Currency":"String","Total":0,"AmountPaid":0,"Balance":0,"IsPaid":false,"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-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","CreatedByUID":"00000000000000000000000000000000"}]}