Account endpoint

This topic provides a quick reference for the method signatures of account API methods.

Location: http://smile.example.com:port/stage/smile/ws/v2/account

WSDL: http://smile.example.com:port/stage/smile/ws/v2/account?wsdl

Table 1. Account API methods
Method	Method signature	Purpose
addDeferredCharge()	`addDeferredCharge( string usn, ChargeRequest charge)`	Adds deferred item charges to an account.
allocate()	`void allocate( string usn, AllocationRequests allocationRequests)`	Allocates transactions within an account.
compileChargeList()	`NewInvoiceRequest compileChargeList( string usn, ChargeListCompilationRequest chargeListCompilationRequest)`	Compiles a quote of charges for an account.
createBond()	`ItemisedTransactionDetail createBond( BondRequest bondRequest)`	Creates a bond on an account.
createCostCentre()	`CostCentree createCostCentre( NewCostCentre newCostCentre)`	Creates a new cost centre for an account.
createPurchaseOrder()	`PurchaseOrder createPurchaseOrder( NewPurchaseOrderRequest newPurchaseOrderRequest)`	Returns a purchase order document that has been persisted.
deletecCostCentre()	`void deleteCostCentre( int costCentreId)`	Deletes an unused cost centre form an account.
echo()	`string echo(string value)`	Returns any value passed to the method.
findAccount()	`Account findAccount( SearchCondition searchCondition)`	Searches by custom field value for an account and returns account information.
findAccounts()	`AccountSearchResultList findAccounts( SearchCondition searchCondition, int limit, int offset)`	Searches by custom field for non-closed accounts which are not subscriptions and returns information about any matches.
findCostCentre()	`CostCentres findCostCentre( string usn, string costCentreName)`	Searches cost centres of an account by cost centre name.
get()	`Account get(string usn)`	Searches by USN for an account and returns account and subscription information.
getAccountInfo()	`Account getAccountInfo(string usn)`	Searches by USN for an account and returns account information.
getAccountSummary()	`AccountSummary getAccountSummary( string usn)`	Searches by USN for an account and returns the account balance, treatment level, aged balances and the number of active subscriptions on the account.
getBondTypes()	`BondTypes getBondTypes()`	Returns the bond types that are available in Smile.
getCostCentre()	`CostCentre getCostCentre( int costCentreId)`	Retrieves cost centre information for a given ID.
getCostCentres()	`CostCentres getCostCentres( string usn)`	Returns a list of cost centres that are associated with an account.
getDeferredCharges()	`DeferredChargeList getDeferredCharges( string usn)`	Returns a list of deferred charges for a given USN.
getFutureBilling()	`FutureInvoiceList getFutureBilling( string usn, FutureInvoiceRequest request)`	Returns a future invoice list for an account, including subscriptions, for given invoicing end date(s).
getHeldBonds()	`Bonds getHeldBonds( string usn)`	Returns a list of bonds on an account, including released bonds.
getPurchaseOrder()	`PurchaseOrder getPurchaseOrder( string purchaseOrderId)`	Returns the account purchase order for the given ID.
getRatings()	`ActivityBatchURL getRatings( string transactionNumber)`	Returns a URL from which you can download the rated activity statements for a given invoice.
getTransaction()	`TransactionDetail getTransaction( string transactionNumber)`	Searches by transaction number for a transaction and returns transaction information.
getTransactionDocument()	`DocumentReferenceType getTransactionDocument( string transactionNumber)`	Searches by transaction number for a transaction and returns transaction information in a rendered document format.
getTransactionList()	`TransactionList getTransactionList( string usn, dateTime startTimestamp, dateTime endTimestamp)`	Returns a list of transactions on an account.
listPurchaseOrders()	`PurchaseOrderList listPurchaseOrders( string account)`	Returns a list of purchase orders for an account.
migrateOpenTransaction()	`ItemisedTransactionDetail migrateOpenTransaction( string openTransactionNumber, string targetAccountUsn)`	Moves an open transaction to another account.
raiseAdjustment()	`TransactionDetail raiseAdjustment( string usn, int adjustmentType, dateTime effective, decimal amount, decimal gst, string comment, AllocationRequest allocationRequest)`	Raises a credit or debit adjustment against an account.
raiseInvoice()	`ItemisedTransactionDetail raiseInvoice( string usn, NewInvoiceRequest newInvoiceRequest)`	Raises an invoice to an account.
raiseReimbursement()	`TransactionDetail raiseReimbursement( string usn, ReimbursementRequest reimbursementRequest)`	Raises a reimbursement to an account.
releaseBond()	`TransactionDetail releaseBonds( string usn, string bondNumber)`	Releases a bond from an account.
reverseTransaction()	`TransactionDetail reverseTransaction( string usn, ReverseTransactionRequest reverseTransactionRequest)`	Reverses a transaction.
update()	`Account update( string usn, Account account)`	Updates account information.
updateCostCentre()	`void updateCostCentre( CostCentre costCentre)`	Updates cost centre information on an account.
updatePurchaseOrder()	`void updatePurchaseOrder( PurchaseOrder purchaseOrder)`	Updates the details of a purchase order.