Trendsic Platform Service

<back to all web services

InvoiceGenerateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/invoice/generate/{ProjectUID}/{InvoiceStartDate}/{InvoiceEndDate}
InvoiceGenerateRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectUIDpathGuidNo
InvoiceStartDatepathDateTimeNo
InvoiceEndDatepathDateTimeNo
InvoiceGenerateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProjectInvoiceformList<InvoiceLineItem>No
InvoiceLineItem Parameters:
NameParameterData TypeRequiredDescription
InvoiceLineItemIDformintNo
InvoiceIDformintNo
TypeformstringNo
NameformstringNo
Quantityformint?No
PercentageAdjustformdecimal?No
AmountAdjustformdecimal?No
Priceformdecimal?No
DescriptionformstringNo
NotesformstringNo
IsTaxableformbool?No
DisplayOrderformint?No
IsLockedformbool?No
IsDeletedformbool?No
IsPaidformbool?No
CreatedDateformDateTime?No
ModifiedDateformDateTime?No
CreatedByUIDformGuid?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","CreatedByUID":"00000000000000000000000000000000"}]}