| POST | /api/SalesForce/InvoiceCollection |
|---|
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 SalesForceInvoiceReply:
class_name: Optional[str] = None
unique_id: Optional[str] = None
created_date_time: Optional[datetime.datetime] = None
client_id: Optional[int] = None
error_code: Optional[int] = None
error_message: Optional[str] = None
inv_batch_no: Optional[int] = None
inv_amount: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceInvoiceCollectionReply(IHaveErrorField):
invoice_reply: Optional[List[SalesForceInvoiceReply]] = None
is_error: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceInvoiceItem:
class_name: Optional[str] = None
unique_id: Optional[str] = None
created_date_time: Optional[datetime.datetime] = None
client_id: Optional[int] = None
product_name: Optional[str] = None
amount_due: Optional[str] = None
product_type: Optional[str] = None
act_pattern_type_id: Optional[int] = None
term_start_date: Optional[datetime.datetime] = None
term_end_date: Optional[datetime.datetime] = None
recognition_period: Optional[int] = None
revenue_account: Optional[str] = None
accounts_receivable_account: Optional[str] = None
liability_account: Optional[str] = None
credit_expense_account: Optional[str] = None
invoice_clearing_account: Optional[str] = None
cost_center: Optional[str] = None
region: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceInvoice:
class_name: Optional[str] = None
unique_id: Optional[str] = None
created_date_time: Optional[datetime.datetime] = None
client_id: Optional[int] = None
group_id: Optional[str] = None
user_id: Optional[str] = None
opportunity_id: Optional[str] = None
invoice_due_date: Optional[datetime.datetime] = None
installments: Optional[int] = None
frequency: Optional[int] = None
bh_user_id: Optional[int] = None
description: Optional[str] = None
deliver: Optional[bool] = None
currency_type: Optional[str] = None
invoice_items: Optional[List[SalesForceInvoiceItem]] = None
invoice_no: Optional[int] = None
invoice_amt: Optional[Decimal] = None
external_inv_batch_no: Optional[str] = None
exempt_from_late_fee: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceInvoiceCollection:
invoice_collection: Optional[List[SalesForceInvoice]] = None
Python SalesForceInvoiceCollection 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 /api/SalesForce/InvoiceCollection HTTP/1.1
Host: devapi.billhighway.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SalesForceInvoiceCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
<InvoiceCollection>
<SalesForceInvoice>
<BhUserId>0</BhUserId>
<ClassName>String</ClassName>
<ClientId>0</ClientId>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<CurrencyType>String</CurrencyType>
<Deliver>false</Deliver>
<Description>String</Description>
<ExemptFromLateFee>false</ExemptFromLateFee>
<ExternalInvBatchNo>String</ExternalInvBatchNo>
<Frequency>0</Frequency>
<GroupId>String</GroupId>
<Installments>0</Installments>
<InvoiceAmt>0</InvoiceAmt>
<InvoiceDueDate>0001-01-01T00:00:00</InvoiceDueDate>
<InvoiceItems>
<SalesForceInvoiceItem>
<AccountsReceivableAccount>String</AccountsReceivableAccount>
<ActPatternTypeId>0</ActPatternTypeId>
<AmountDue>String</AmountDue>
<ClassName>String</ClassName>
<ClientId>0</ClientId>
<CostCenter>String</CostCenter>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<CreditExpenseAccount>String</CreditExpenseAccount>
<InvoiceClearingAccount>String</InvoiceClearingAccount>
<LiabilityAccount>String</LiabilityAccount>
<ProductName>String</ProductName>
<ProductType>String</ProductType>
<RecognitionPeriod>0</RecognitionPeriod>
<Region>String</Region>
<RevenueAccount>String</RevenueAccount>
<TermEndDate>0001-01-01T00:00:00</TermEndDate>
<TermStartDate>0001-01-01T00:00:00</TermStartDate>
<UniqueId>String</UniqueId>
</SalesForceInvoiceItem>
</InvoiceItems>
<InvoiceNo>0</InvoiceNo>
<OpportunityId>String</OpportunityId>
<UniqueId>String</UniqueId>
<UserId>String</UserId>
</SalesForceInvoice>
</InvoiceCollection>
</SalesForceInvoiceCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SalesForceInvoiceCollectionReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
<InvoiceReply>
<SalesForceInvoiceReply>
<ClassName>String</ClassName>
<ClientId>0</ClientId>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<ErrorCode>0</ErrorCode>
<ErrorMessage>String</ErrorMessage>
<InvAmount>0</InvAmount>
<InvBatchNo>0</InvBatchNo>
<UniqueId>String</UniqueId>
</SalesForceInvoiceReply>
</InvoiceReply>
</SalesForceInvoiceCollectionReply>