Difference between revisions of "API/EndUser"
(End User API functions) |
|||
| Line 4: | Line 4: | ||
====== Description ====== | ====== Description ====== | ||
| + | |||
| + | Returns a list of invoices. | ||
====== Input ====== | ====== Input ====== | ||
| + | |||
| + | username, password | ||
====== Output ====== | ====== Output ====== | ||
| + | |||
| + | invoice_id, total_amount, total_tax, outstanding_amount, outstanding_tax, invoice_start, invoice_end, invoice_period_start, invoice_period_end, invoice_issue, invoice_due, invoice_status, invoice_status_name | ||
==== getInvoiceById ==== | ==== getInvoiceById ==== | ||
====== Description ====== | ====== Description ====== | ||
| + | |||
| + | Given an invoice_id, returns the invoice in PDF format | ||
====== Input ====== | ====== Input ====== | ||
| + | |||
| + | username, password, invoice_id | ||
====== Output ====== | ====== Output ====== | ||
| + | |||
| + | filename, account_id, file | ||
==== getAccountBalanceSummaryInfo ==== | ==== getAccountBalanceSummaryInfo ==== | ||
====== Description ====== | ====== Description ====== | ||
| + | |||
| + | Returns the balance of the users account | ||
====== Input ====== | ====== Input ====== | ||
| + | |||
| + | username, password | ||
====== Output ====== | ====== Output ====== | ||
| + | |||
| + | amount_extax, amount_tax, unallocated_extax, unallocated_tax, disputed_extax, disputed_tax, paymentplan_extax, paymentplan_tax | ||
==== makeAdHocPayment ==== | ==== makeAdHocPayment ==== | ||
====== Description ====== | ====== Description ====== | ||
| + | |||
| + | Using the users stored credit card details, this will take a payment of "amount" | ||
====== Input ====== | ====== Input ====== | ||
| + | |||
| + | username, password, amount | ||
====== Output ====== | ====== Output ====== | ||
| + | |||
| + | result, receipt, processed | ||
==== getContactByAccountAndType ==== | ==== getContactByAccountAndType ==== | ||
====== Description ====== | ====== Description ====== | ||
| + | |||
| + | Returns information about contacts for the account | ||
====== Input ====== | ====== Input ====== | ||
| + | |||
| + | username, password, contactTypeName, ContactId | ||
====== Output ====== | ====== Output ====== | ||
| + | |||
| + | contactList (XML in CDATA) | ||
==== createSession ==== | ==== createSession ==== | ||
====== Description ====== | ====== Description ====== | ||
| + | |||
| + | Creates a valid UserPortal session | ||
====== Input ====== | ====== Input ====== | ||
| + | |||
| + | username, password | ||
====== Output ====== | ====== Output ====== | ||
| + | |||
| + | session | ||
==== updateAccount ==== | ==== updateAccount ==== | ||
====== Description ====== | ====== Description ====== | ||
| + | |||
| + | Updates details for the user's account | ||
====== Input ====== | ====== Input ====== | ||
| + | |||
| + | username, password, AccountType, PrimaryContact, AccountContactType, AccountOrganisation, AccountReference | ||
====== Output ====== | ====== Output ====== | ||
| + | |||
| + | Result | ||
==== addOneTimeBoltOn ==== | ==== addOneTimeBoltOn ==== | ||
| Line 62: | Line 104: | ||
====== Input ====== | ====== Input ====== | ||
| + | |||
| + | username, password | ||
====== Output ====== | ====== Output ====== | ||
| Line 70: | Line 114: | ||
====== Input ====== | ====== Input ====== | ||
| + | |||
| + | username, password | ||
====== Output ====== | ====== Output ====== | ||
| Line 76: | Line 122: | ||
== Services.wsdl == | == Services.wsdl == | ||
| − | |||
== ServiceDesk.wsdl == | == ServiceDesk.wsdl == | ||
Revision as of 09:07, 19 November 2014
Contents
Account.wsdl
invoicesByAccount
Description
Returns a list of invoices.
Input
username, password
Output
invoice_id, total_amount, total_tax, outstanding_amount, outstanding_tax, invoice_start, invoice_end, invoice_period_start, invoice_period_end, invoice_issue, invoice_due, invoice_status, invoice_status_name
getInvoiceById
Description
Given an invoice_id, returns the invoice in PDF format
Input
username, password, invoice_id
Output
filename, account_id, file
getAccountBalanceSummaryInfo
Description
Returns the balance of the users account
Input
username, password
Output
amount_extax, amount_tax, unallocated_extax, unallocated_tax, disputed_extax, disputed_tax, paymentplan_extax, paymentplan_tax
makeAdHocPayment
Description
Using the users stored credit card details, this will take a payment of "amount"
Input
username, password, amount
Output
result, receipt, processed
getContactByAccountAndType
Description
Returns information about contacts for the account
Input
username, password, contactTypeName, ContactId
Output
contactList (XML in CDATA)
createSession
Description
Creates a valid UserPortal session
Input
username, password
Output
session
updateAccount
Description
Updates details for the user's account
Input
username, password, AccountType, PrimaryContact, AccountContactType, AccountOrganisation, AccountReference
Output
Result
addOneTimeBoltOn
Description
Input
username, password
Output
setServiceSpendLimit
Description
Input
username, password
