| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InvoiceGenerateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ProjectInvoice>
<InvoiceLineItem>
<AmountAdjust>0</AmountAdjust>
<CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Description>String</Description>
<DisplayOrder>0</DisplayOrder>
<InvoiceID>0</InvoiceID>
<InvoiceLineItemID>0</InvoiceLineItemID>
<IsDeleted>false</IsDeleted>
<IsLocked>false</IsLocked>
<IsPaid>false</IsPaid>
<IsTaxable>false</IsTaxable>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<Name>String</Name>
<Notes>String</Notes>
<PercentageAdjust>0</PercentageAdjust>
<Price>0</Price>
<Quantity>0</Quantity>
<Type>String</Type>
</InvoiceLineItem>
</ProjectInvoice>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</InvoiceGenerateResponse>