| Requires any of the roles: | Agent, Administrator |
| PUT,OPTIONS | /v1/invoice |
|---|
export class Invoice
{
public InvoiceID: number;
public InvoiceUID?: string;
public ProjectUID?: string;
public InvoiceNumber: string;
public InvoiceDate?: string;
public DueDate?: string;
public FromName: string;
public FromPhone: string;
public FromEmail: string;
public FromAddress: string;
public FromDesc: string;
public ToName: string;
public ToPhone: string;
public ToEmail: string;
public ToAddress: string;
public ToDesc: string;
public Notes: string;
public Currency: string;
public Status: number;
public Total?: number;
public IsPaid?: boolean;
public PaidDate?: string;
public IsDeleted?: boolean;
public IsLocked?: boolean;
public CreatedDate?: string;
public ModifiedDate?: string;
public CreatedByUID?: string;
public constructor(init?: Partial<Invoice>) { (Object as any).assign(this, init); }
}
export class InvoiceLineItem
{
public InvoiceLineItemID: number;
public InvoiceID: number;
public Type: string;
public Name: string;
public Quantity?: number;
public PercentageAdjust?: number;
public AmountAdjust?: number;
public Price?: number;
public Description: string;
public Notes: string;
public IsTaxable?: boolean;
public DisplayOrder?: number;
public IsLocked?: boolean;
public IsDeleted?: boolean;
public IsPaid?: boolean;
public CreatedDate?: string;
public ModifiedDate?: string;
public CreatedByUID?: string;
public constructor(init?: Partial<InvoiceLineItem>) { (Object as any).assign(this, init); }
}
export class UpdateInvoiceRequest
{
public Invoice: Invoice;
public LineItems: InvoiceLineItem[] = [];
public constructor(init?: Partial<UpdateInvoiceRequest>) { (Object as any).assign(this, init); }
}
export class UpdateInvoiceResponse
{
public ResponseStatus: ResponseStatus;
public Success: boolean;
public constructor(init?: Partial<UpdateInvoiceResponse>) { (Object as any).assign(this, init); }
}
TypeScript UpdateInvoiceRequest DTOs
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
}