Trendsic Platform Service

PortalInvoiceRequest

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


export class InvoiceLineItem
{
    public InvoiceLineItemID: number;
    public InvoiceID: number;
    public Type: string;
    public Name: string;
    public Quantity?: number;
    public PercentageAdjust?: number;
    public AmountAdjust?: number;
    public Price?: number;
    public Description: string;
    public Notes: string;
    public IsTaxable?: boolean;
    public DisplayOrder?: number;
    public IsLocked?: boolean;
    public IsDeleted?: boolean;
    public IsPaid?: boolean;
    public CreatedDate?: string;
    public ModifiedDate?: string;
    public CreatedByUID?: string;

    public constructor(init?: Partial<InvoiceLineItem>) { (Object as any).assign(this, init); }
}

export class PortalInvoiceResponse
{
    public ResponseStatus: ResponseStatus;
    public InvoiceNumber: string;
    public InvoiceDate?: string;
    public DueDate?: string;
    public FromName: string;
    public FromAddress: string;
    public ToName: string;
    public ToAddress: string;
    public Currency: string;
    public Total: number;
    public AmountPaid: number;
    public Balance: number;
    public IsPaid: boolean;
    public LineItems: InvoiceLineItem[] = [];

    public constructor(init?: Partial<PortalInvoiceResponse>) { (Object as any).assign(this, init); }
}

export class PortalInvoiceRequest
{
    public Token: string;

    public constructor(init?: Partial<PortalInvoiceRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	]
}