Trendsic Platform Service

<back to all web services

PortalInvoiceRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/invoice
PortalInvoiceRequest Parameters:
NameParameterData TypeRequiredDescription
TokenpathstringNo
PortalInvoiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
InvoiceNumberformstringNo
InvoiceDateformDateTime?No
DueDateformDateTime?No
FromNameformstringNo
FromAddressformstringNo
ToNameformstringNo
ToAddressformstringNo
CurrencyformstringNo
TotalformdecimalNo
AmountPaidformdecimalNo
BalanceformdecimalNo
IsPaidformboolNo
LineItemsformList<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 .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 /portal/{Token}/invoice 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"}},"InvoiceNumber":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","FromName":"String","FromAddress":"String","ToName":"String","ToAddress":"String","Currency":"String","Total":0,"AmountPaid":0,"Balance":0,"IsPaid":false,"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"}]}