Trendsic Platform Service

GetInvoiceByUidRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/invoice/{InvoiceUID}

import Foundation
import ServiceStack

public class GetInvoiceByUidRequest : Codable
{
    public var invoiceUID:String

    required public init(){}
}

public class GetInvoiceByUidResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var invoiceData:InvoiceData

    required public init(){}
}

public class InvoiceData : Codable
{
    public var invoice:Invoice
    public var lineItems:[InvoiceLineItem] = []

    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 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 GetInvoiceByUidRequest 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.

GET /v1/invoice/{InvoiceUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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
		}
	},
	InvoiceData: 
	{
		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
			}
		]
	}
}