Trendsic Platform Service

<back to all web services

UpdateInvoiceRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
PUT,OPTIONS/v1/invoice
UpdateInvoiceRequest Parameters:
NameParameterData TypeRequiredDescription
InvoicebodyInvoiceNo
LineItemsbodyList<InvoiceLineItem>No
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
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
UpdateInvoiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SuccessformboolNo

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.

PUT /v1/invoice HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Invoice":{"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"},"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-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","CreatedByUID":"00000000000000000000000000000000"}]}
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"}},"Success":false}