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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetInvoicesByProjectRequest
{
    open var ProjectUID:UUID? = null
}

open class GetInvoicesByProjectResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Invoices:ArrayList<Invoice> = ArrayList<Invoice>()
    open var ProjectInvoiceData:ProjectInvoiceData? = null
}

open class Invoice
{
    open var InvoiceID:Int? = null
    open var InvoiceUID:UUID? = null
    open var ProjectUID:UUID? = null
    open var InvoiceNumber:String? = null
    open var InvoiceDate:Date? = null
    open var DueDate:Date? = null
    open var FromName:String? = null
    open var FromPhone:String? = null
    open var FromEmail:String? = null
    open var FromAddress:String? = null
    open var FromDesc:String? = null
    open var ToName:String? = null
    open var ToPhone:String? = null
    open var ToEmail:String? = null
    open var ToAddress:String? = null
    open var ToDesc:String? = null
    open var Notes:String? = null
    open var Currency:String? = null
    open var Status:Int? = null
    open var Total:BigDecimal? = null
    open var IsPaid:Boolean? = null
    open var PaidDate:Date? = null
    open var IsDeleted:Boolean? = null
    open var IsLocked:Boolean? = null
    open var CreatedDate:Date? = null
    open var ModifiedDate:Date? = null
    open var CreatedByUID:UUID? = null
}

open class ProjectInvoiceData
{
    open var InvoicedAmount:BigDecimal? = null
    open var PaidAmount:BigDecimal? = null
}

Kotlin GetInvoicesByProjectRequest 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/project/{ProjectUID} 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
		}
	},
	Invoices: 
	[
		{
			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
		}
	],
	ProjectInvoiceData: 
	{
		InvoicedAmount: 0,
		PaidAmount: 0
	}
}