Trendsic Platform Service

<back to all web services

PortalInvoiceRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/invoice
import Foundation
import ServiceStack

public class PortalInvoiceRequest : Codable
{
    public var token:String

    required public init(){}
}

public class PortalInvoiceResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var invoiceNumber:String
    public var invoiceDate:Date?
    public var dueDate:Date?
    public var fromName:String
    public var fromAddress:String
    public var toName:String
    public var toAddress:String
    public var currency:String
    public var total:Double
    public var amountPaid:Double
    public var balance:Double
    public var isPaid:Bool
    public var lineItems:[InvoiceLineItem] = []

    required public init(){}
}

public class InvoiceLineItem : Codable
{
    public var invoiceLineItemID:Int
    public var invoiceID:Int
    public var type:String
    public var name:String
    public var quantity:Int?
    public var percentageAdjust:Double?
    public var amountAdjust:Double?
    public var price:Double?
    public var Description:String
    public var notes:String
    public var isTaxable:Bool?
    public var displayOrder:Int?
    public var isLocked:Bool?
    public var isDeleted:Bool?
    public var isPaid:Bool?
    public var createdDate:Date?
    public var modifiedDate:Date?
    public var createdByUID:String?

    required public init(){}
}


Swift 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"}]}