|
|
| (2 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | == Account.wsdl ==
| |
| | | | |
| − | ==== invoicesByAccount ====
| + | There are different API types, listed below; |
| | | | |
| − | ====== Description ======
| + | [[API/EndUser/Account|Account - Account API]] |
| | | | |
| − | Returns a list of invoices.
| + | [[API/EndUser/Services|Services - Services API]] |
| | | | |
| − | ====== Input ======
| + | [[API/EndUser/ServiceDesk|ServiceDesk - Service Desk API]] |
| − | | |
| − | 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
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | ==== getServiceSpendLimit ====
| |
| − | | |
| − | == Services.wsdl ==
| |
| − | | |
| − | == ServiceDesk.wsdl ==
| |
| − | | |
| − | ==== getServiceDeskList ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns the last 6 months of service desk tickets against the account
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | id, created_date, queue, category, subcategory, subject, num_notes, last_updated, status
| |
| − | | |
| − | ==== getServiceDeskTicketDetail ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns details about an individual service desk ticket
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, ticket_id
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | created_date, queue, category, subcategory, subject, notes
| |
| − | | |
| − | ==== newServiceRequest ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Creates a new service desk request
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, queue_id, category_id, subcategory_id, subject, details
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | ticket_id
| |
| − | | |
| − | ==== updateServiceRequest ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Adds a note to an existing service desk ticket
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, ticket_id, details, subject
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | note_id
| |
