| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/invoice |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Invoice:
invoice_i_d: int = 0
invoice_u_i_d: Optional[str] = None
project_u_i_d: Optional[str] = None
invoice_number: Optional[str] = None
invoice_date: Optional[datetime.datetime] = None
due_date: Optional[datetime.datetime] = None
from_name: Optional[str] = None
from_phone: Optional[str] = None
from_email: Optional[str] = None
from_address: Optional[str] = None
from_desc: Optional[str] = None
to_name: Optional[str] = None
to_phone: Optional[str] = None
to_email: Optional[str] = None
to_address: Optional[str] = None
to_desc: Optional[str] = None
notes: Optional[str] = None
currency: Optional[str] = None
status: int = 0
total: Optional[Decimal] = None
is_paid: Optional[bool] = None
paid_date: Optional[datetime.datetime] = None
is_deleted: Optional[bool] = None
is_locked: Optional[bool] = None
created_date: Optional[datetime.datetime] = None
modified_date: Optional[datetime.datetime] = None
created_by_u_i_d: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceLineItem:
invoice_line_item_i_d: int = 0
invoice_i_d: int = 0
type: Optional[str] = None
name: Optional[str] = None
quantity: Optional[int] = None
percentage_adjust: Optional[Decimal] = None
amount_adjust: Optional[Decimal] = None
price: Optional[Decimal] = None
description: Optional[str] = None
notes: Optional[str] = None
is_taxable: Optional[bool] = None
display_order: Optional[int] = None
is_locked: Optional[bool] = None
is_deleted: Optional[bool] = None
is_paid: Optional[bool] = None
created_date: Optional[datetime.datetime] = None
modified_date: Optional[datetime.datetime] = None
created_by_u_i_d: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InsertInvoiceRequest:
invoice: Optional[Invoice] = None
line_items: List[InvoiceLineItem] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceIdentification:
invoice_id: int = 0
invoice_uid: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InsertInvoiceResponse:
response_status: Optional[ResponseStatus] = None
new_invoice_identification: Optional[InvoiceIdentification] = None
Python InsertInvoiceRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<InsertInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Invoice>
<CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Currency>String</Currency>
<DueDate>0001-01-01T00:00:00</DueDate>
<FromAddress>String</FromAddress>
<FromDesc>String</FromDesc>
<FromEmail>String</FromEmail>
<FromName>String</FromName>
<FromPhone>String</FromPhone>
<InvoiceDate>0001-01-01T00:00:00</InvoiceDate>
<InvoiceID>0</InvoiceID>
<InvoiceNumber>String</InvoiceNumber>
<InvoiceUID>00000000-0000-0000-0000-000000000000</InvoiceUID>
<IsDeleted>false</IsDeleted>
<IsLocked>false</IsLocked>
<IsPaid>false</IsPaid>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<Notes>String</Notes>
<PaidDate>0001-01-01T00:00:00</PaidDate>
<ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
<Status>0</Status>
<ToAddress>String</ToAddress>
<ToDesc>String</ToDesc>
<ToEmail>String</ToEmail>
<ToName>String</ToName>
<ToPhone>String</ToPhone>
<Total>0</Total>
</Invoice>
<LineItems>
<InvoiceLineItem>
<AmountAdjust>0</AmountAdjust>
<CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Description>String</Description>
<DisplayOrder>0</DisplayOrder>
<InvoiceID>0</InvoiceID>
<InvoiceLineItemID>0</InvoiceLineItemID>
<IsDeleted>false</IsDeleted>
<IsLocked>false</IsLocked>
<IsPaid>false</IsPaid>
<IsTaxable>false</IsTaxable>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<Name>String</Name>
<Notes>String</Notes>
<PercentageAdjust>0</PercentageAdjust>
<Price>0</Price>
<Quantity>0</Quantity>
<Type>String</Type>
</InvoiceLineItem>
</LineItems>
</InsertInvoiceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InsertInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<NewInvoiceIdentification>
<InvoiceId>0</InvoiceId>
<InvoiceUid>00000000-0000-0000-0000-000000000000</InvoiceUid>
</NewInvoiceIdentification>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</InsertInvoiceResponse>