Trendsic Platform Service

<back to all web services

InsertInvoiceRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/invoice
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class InsertInvoiceRequest
{
    open var Invoice:Invoice? = null
    open var LineItems:ArrayList<InvoiceLineItem> = ArrayList<InvoiceLineItem>()
}

open class Invoice
{
    open var InvoiceID:Int? = null
    open var InvoiceUID:UUID? = null
    open var ProjectUID:UUID? = null
    open var InvoiceNumber:String? = null
    open var InvoiceDate:Date? = null
    open var DueDate:Date? = null
    open var FromName:String? = null
    open var FromPhone:String? = null
    open var FromEmail:String? = null
    open var FromAddress:String? = null
    open var FromDesc:String? = null
    open var ToName:String? = null
    open var ToPhone:String? = null
    open var ToEmail:String? = null
    open var ToAddress:String? = null
    open var ToDesc:String? = null
    open var Notes:String? = null
    open var Currency:String? = null
    open var Status:Int? = null
    open var Total:BigDecimal? = null
    open var IsPaid:Boolean? = null
    open var PaidDate:Date? = null
    open var IsDeleted:Boolean? = null
    open var IsLocked:Boolean? = null
    open var CreatedDate:Date? = null
    open var ModifiedDate:Date? = null
    open var CreatedByUID:UUID? = null
}

open class InvoiceLineItem
{
    open var InvoiceLineItemID:Int? = null
    open var InvoiceID:Int? = null
    open var Type:String? = null
    open var Name:String? = null
    open var Quantity:Int? = null
    open var PercentageAdjust:BigDecimal? = null
    open var AmountAdjust:BigDecimal? = null
    open var Price:BigDecimal? = null
    open var Description:String? = null
    open var Notes:String? = null
    open var IsTaxable:Boolean? = null
    open var DisplayOrder:Int? = null
    open var IsLocked:Boolean? = null
    open var IsDeleted:Boolean? = null
    open var IsPaid:Boolean? = null
    open var CreatedDate:Date? = null
    open var ModifiedDate:Date? = null
    open var CreatedByUID:UUID? = null
}

open class InsertInvoiceResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var NewInvoiceIdentification:InvoiceIdentification? = null
}

open class InvoiceIdentification
{
    open var InvoiceId:Int? = null
    open var InvoiceUid:UUID? = null
}

Kotlin InsertInvoiceRequest DTOs

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.

POST /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"}},"NewInvoiceIdentification":{"InvoiceId":0,"InvoiceUid":"00000000000000000000000000000000"}}