| Requires any of the roles: | Agent, Administrator |
| PUT,OPTIONS | /v1/invoice |
|---|
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type Invoice() =
member val InvoiceID:Int32 = new Int32() with get,set
member val InvoiceUID:Nullable<Guid> = new Nullable<Guid>() with get,set
member val ProjectUID:Nullable<Guid> = new Nullable<Guid>() with get,set
member val InvoiceNumber:String = null with get,set
member val InvoiceDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DueDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val FromName:String = null with get,set
member val FromPhone:String = null with get,set
member val FromEmail:String = null with get,set
member val FromAddress:String = null with get,set
member val FromDesc:String = null with get,set
member val ToName:String = null with get,set
member val ToPhone:String = null with get,set
member val ToEmail:String = null with get,set
member val ToAddress:String = null with get,set
member val ToDesc:String = null with get,set
member val Notes:String = null with get,set
member val Currency:String = null with get,set
member val Status:Int32 = new Int32() with get,set
member val Total:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val IsPaid:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val PaidDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val IsDeleted:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val IsLocked:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val CreatedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ModifiedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CreatedByUID:Nullable<Guid> = new Nullable<Guid>() with get,set
[<AllowNullLiteral>]
type InvoiceLineItem() =
member val InvoiceLineItemID:Int32 = new Int32() with get,set
member val InvoiceID:Int32 = new Int32() with get,set
member val Type:String = null with get,set
member val Name:String = null with get,set
member val Quantity:Nullable<Int32> = new Nullable<Int32>() with get,set
member val PercentageAdjust:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val AmountAdjust:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Price:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Description:String = null with get,set
member val Notes:String = null with get,set
member val IsTaxable:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val DisplayOrder:Nullable<Int32> = new Nullable<Int32>() with get,set
member val IsLocked:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val IsDeleted:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val IsPaid:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val CreatedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ModifiedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CreatedByUID:Nullable<Guid> = new Nullable<Guid>() with get,set
[<AllowNullLiteral>]
type UpdateInvoiceRequest() =
member val Invoice:Invoice = null with get,set
member val LineItems:ResizeArray<InvoiceLineItem> = new ResizeArray<InvoiceLineItem>() with get,set
[<AllowNullLiteral>]
type UpdateInvoiceResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val Success:Boolean = new Boolean() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Invoice:
{
InvoiceID: 0,
InvoiceUID: 00000000000000000000000000000000,
ProjectUID: 00000000000000000000000000000000,
InvoiceNumber: String,
InvoiceDate: 0001-01-01,
DueDate: 0001-01-01,
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-01,
IsDeleted: False,
IsLocked: False,
CreatedDate: 0001-01-01,
ModifiedDate: 0001-01-01,
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-01,
ModifiedDate: 0001-01-01,
CreatedByUID: 00000000000000000000000000000000
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}