Trendsic Platform Service

<back to all web services

GetInvoicesByProjectRequest

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

class GetInvoicesByProjectRequest implements IConvertible
{
    String? ProjectUID;

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

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

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

    getTypeName() => "GetInvoicesByProjectRequest";
    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 ProjectInvoiceData implements IConvertible
{
    double? InvoicedAmount;
    double? PaidAmount;

    ProjectInvoiceData({this.InvoicedAmount,this.PaidAmount});
    ProjectInvoiceData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        InvoicedAmount = JsonConverters.toDouble(json['InvoicedAmount']);
        PaidAmount = JsonConverters.toDouble(json['PaidAmount']);
        return this;
    }

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

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

class GetInvoicesByProjectResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<Invoice>? Invoices = [];
    ProjectInvoiceData? ProjectInvoiceData;

    GetInvoicesByProjectResponse({this.ResponseStatus,this.Invoices,this.ProjectInvoiceData});
    GetInvoicesByProjectResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Invoices': JsonConverters.toJson(Invoices,'List<Invoice>',context!),
        'ProjectInvoiceData': JsonConverters.toJson(ProjectInvoiceData,'ProjectInvoiceData',context!)
    };

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

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

Dart GetInvoicesByProjectRequest DTOs

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

HTTP + XML

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

GET /v1/invoice/project/{ProjectUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetInvoicesByProjectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Invoices>
    <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>
  </Invoices>
  <ProjectInvoiceData>
    <InvoicedAmount>0</InvoicedAmount>
    <PaidAmount>0</PaidAmount>
  </ProjectInvoiceData>
  <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>
</GetInvoicesByProjectResponse>