| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/invoice/generate/{ProjectUID}/{InvoiceStartDate}/{InvoiceEndDate} |
|---|
"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 InvoiceGenerateResponse {
/** @param {{ResponseStatus?:ResponseStatus,ProjectInvoice?:InvoiceLineItem[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {InvoiceLineItem[]} */
ProjectInvoice = [];
}
export class InvoiceGenerateRequest {
/** @param {{ProjectUID?:string,InvoiceStartDate?:string,InvoiceEndDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ProjectUID;
/** @type {string} */
InvoiceStartDate;
/** @type {string} */
InvoiceEndDate;
}
JavaScript InvoiceGenerateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/invoice/generate/{ProjectUID}/{InvoiceStartDate}/{InvoiceEndDate} 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
}
},
ProjectInvoice:
[
{
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
}
]
}