| GET,OPTIONS | /portal/{Token}/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 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 PortalInvoiceResponse:
response_status: Optional[ResponseStatus] = None
invoice_number: Optional[str] = None
invoice_date: Optional[datetime.datetime] = None
due_date: Optional[datetime.datetime] = None
from_name: Optional[str] = None
from_address: Optional[str] = None
to_name: Optional[str] = None
to_address: Optional[str] = None
currency: Optional[str] = None
total: Decimal = decimal.Decimal(0)
amount_paid: Decimal = decimal.Decimal(0)
balance: Decimal = decimal.Decimal(0)
is_paid: bool = False
line_items: List[InvoiceLineItem] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortalInvoiceRequest:
token: Optional[str] = None
Python PortalInvoiceRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}