Trendsic Platform Service

PortalInvoiceRequest

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

"use strict";
export class InvoiceLineItem {
    /** @param {{InvoiceLineItemID?:number,InvoiceID?:number,Type?:string,Name?:string,Quantity?:number,PercentageAdjust?:number,AmountAdjust?:number,Price?:number,Description?:string,Notes?:string,IsTaxable?:boolean,DisplayOrder?:number,IsLocked?:boolean,IsDeleted?:boolean,IsPaid?:boolean,CreatedDate?:string,ModifiedDate?:string,CreatedByUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    InvoiceLineItemID;
    /** @type {number} */
    InvoiceID;
    /** @type {string} */
    Type;
    /** @type {string} */
    Name;
    /** @type {?number} */
    Quantity;
    /** @type {?number} */
    PercentageAdjust;
    /** @type {?number} */
    AmountAdjust;
    /** @type {?number} */
    Price;
    /** @type {string} */
    Description;
    /** @type {string} */
    Notes;
    /** @type {?boolean} */
    IsTaxable;
    /** @type {?number} */
    DisplayOrder;
    /** @type {?boolean} */
    IsLocked;
    /** @type {?boolean} */
    IsDeleted;
    /** @type {?boolean} */
    IsPaid;
    /** @type {?string} */
    CreatedDate;
    /** @type {?string} */
    ModifiedDate;
    /** @type {?string} */
    CreatedByUID;
}
export class PortalInvoiceResponse {
    /** @param {{ResponseStatus?:ResponseStatus,InvoiceNumber?:string,InvoiceDate?:string,DueDate?:string,FromName?:string,FromAddress?:string,ToName?:string,ToAddress?:string,Currency?:string,Total?:number,AmountPaid?:number,Balance?:number,IsPaid?:boolean,LineItems?:InvoiceLineItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {string} */
    InvoiceNumber;
    /** @type {?string} */
    InvoiceDate;
    /** @type {?string} */
    DueDate;
    /** @type {string} */
    FromName;
    /** @type {string} */
    FromAddress;
    /** @type {string} */
    ToName;
    /** @type {string} */
    ToAddress;
    /** @type {string} */
    Currency;
    /** @type {number} */
    Total;
    /** @type {number} */
    AmountPaid;
    /** @type {number} */
    Balance;
    /** @type {boolean} */
    IsPaid;
    /** @type {InvoiceLineItem[]} */
    LineItems = [];
}
export class PortalInvoiceRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

JavaScript PortalInvoiceRequest 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 /portal/{Token}/invoice 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
		}
	},
	InvoiceNumber: String,
	InvoiceDate: 0001-01-01,
	DueDate: 0001-01-01,
	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-01,
			ModifiedDate: 0001-01-01,
			CreatedByUID: 00000000000000000000000000000000
		}
	]
}