| GET,OPTIONS | /portal/{Token}/invoice |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| InvoiceNumber | form | string | No | |
| InvoiceDate | form | DateTime? | No | |
| DueDate | form | DateTime? | No | |
| FromName | form | string | No | |
| FromAddress | form | string | No | |
| ToName | form | string | No | |
| ToAddress | form | string | No | |
| Currency | form | string | No | |
| Total | form | decimal | No | |
| AmountPaid | form | decimal | No | |
| Balance | form | decimal | No | |
| IsPaid | form | bool | No | |
| LineItems | form | List<InvoiceLineItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceLineItemID | form | int | No | |
| InvoiceID | form | int | No | |
| Type | form | string | No | |
| Name | form | string | No | |
| Quantity | form | int? | No | |
| PercentageAdjust | form | decimal? | No | |
| AmountAdjust | form | decimal? | No | |
| Price | form | decimal? | No | |
| Description | form | string | No | |
| Notes | form | string | No | |
| IsTaxable | form | bool? | No | |
| DisplayOrder | form | int? | No | |
| IsLocked | form | bool? | No | |
| IsDeleted | form | bool? | No | |
| IsPaid | form | bool? | No | |
| CreatedDate | form | DateTime? | No | |
| ModifiedDate | form | DateTime? | No | |
| CreatedByUID | form | Guid? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: 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"}},"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"}]}