Trendsic Platform Service

<back to all web services

GetInvoicesByProjectRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/invoice/project/{ProjectUID}
GetInvoicesByProjectRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectUIDpathGuidNo
GetInvoicesByProjectResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
InvoicesformList<Invoice>No
ProjectInvoiceDataformProjectInvoiceDataNo
Invoice Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDformintNo
InvoiceUIDformGuid?No
ProjectUIDformGuid?No
InvoiceNumberformstringNo
InvoiceDateformDateTime?No
DueDateformDateTime?No
FromNameformstringNo
FromPhoneformstringNo
FromEmailformstringNo
FromAddressformstringNo
FromDescformstringNo
ToNameformstringNo
ToPhoneformstringNo
ToEmailformstringNo
ToAddressformstringNo
ToDescformstringNo
NotesformstringNo
CurrencyformstringNo
StatusformintNo
Totalformdecimal?No
IsPaidformbool?No
PaidDateformDateTime?No
IsDeletedformbool?No
IsLockedformbool?No
CreatedDateformDateTime?No
ModifiedDateformDateTime?No
CreatedByUIDformGuid?No
ProjectInvoiceData Parameters:
NameParameterData TypeRequiredDescription
InvoicedAmountformdecimal?No
PaidAmountformdecimal?No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/invoice/project/{ProjectUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Invoices":[{"InvoiceID":0,"InvoiceUID":"00000000000000000000000000000000","ProjectUID":"00000000000000000000000000000000","InvoiceNumber":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","FromName":"String","FromPhone":"String","FromEmail":"String","FromAddress":"String","FromDesc":"String","ToName":"String","ToPhone":"String","ToEmail":"String","ToAddress":"String","ToDesc":"String","Notes":"String","Currency":"String","Status":0,"Total":0,"IsPaid":false,"PaidDate":"0001-01-01T00:00:00.0000000","IsDeleted":false,"IsLocked":false,"CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","CreatedByUID":"00000000000000000000000000000000"}],"ProjectInvoiceData":{"InvoicedAmount":0,"PaidAmount":0}}