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 Foundation
import ServiceStack

public class GetInvoicesByProjectRequest : Codable
{
    public var projectUID:String

    required public init(){}
}

public class GetInvoicesByProjectResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var invoices:[Invoice] = []
    public var projectInvoiceData:ProjectInvoiceData

    required public init(){}
}

public class Invoice : Codable
{
    public var invoiceID:Int
    public var invoiceUID:String?
    public var projectUID:String?
    public var invoiceNumber:String
    public var invoiceDate:Date?
    public var dueDate:Date?
    public var fromName:String
    public var fromPhone:String
    public var fromEmail:String
    public var fromAddress:String
    public var fromDesc:String
    public var toName:String
    public var toPhone:String
    public var toEmail:String
    public var toAddress:String
    public var toDesc:String
    public var notes:String
    public var currency:String
    public var status:Int
    public var total:Double?
    public var isPaid:Bool?
    public var paidDate:Date?
    public var isDeleted:Bool?
    public var isLocked:Bool?
    public var createdDate:Date?
    public var modifiedDate:Date?
    public var createdByUID:String?

    required public init(){}
}

public class ProjectInvoiceData : Codable
{
    public var invoicedAmount:Double?
    public var paidAmount:Double?

    required public init(){}
}


Swift GetInvoicesByProjectRequest DTOs

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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Invoices":[{"InvoiceID":0,"InvoiceUID":"00000000000000000000000000000000","ProjectUID":"00000000000000000000000000000000","InvoiceNumber":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","IsDeleted":false,"IsLocked":false,"CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","CreatedByUID":"00000000000000000000000000000000"}],"ProjectInvoiceData":{"InvoicedAmount":0,"PaidAmount":0}}