|
|
| 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 ==
| |
| − | | |
| − | ==== serviceList ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns a list of service subscriptions
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | serv_subscr_period_start_date, serv_subscr_period_end_date, service_id, service_identifier, vanity_service_identifier, service_type_id, service_type_name, service_status, service_start_date, service_end_date, service_subscr_start_date, service_subscr_end_date
| |
| − | | |
| − | ==== getServiceSubscriptionPeriodsByService ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | For a given service_id, returns a list of service subscription periods
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, service_id
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | service_subscription_period_id, service_subscription_id, period_start, period_end, external_name
| |
| − | | |
| − | ==== getSuburbByName ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns a list of suburbs
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, suburb, state
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | suburb, postcode, state_territory
| |
| − | | |
| − | ==== getSuburbByPostcode ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns a list of suburbs
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, postcode, state
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | suburb, postcode, state_territory
| |
| − | | |
| − | ==== getStreetAddress ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Search for a street address
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, suburb, postcode, street, number
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | address_id, gnaf_pid, unit_number, unit_type, level_number, level_type, site_name, lot_number, plan_number, road_number_1, road_number_2, road_name, road_suffix, road_type, suburb, state, postcode
| |
| − | | |
| − | ==== getServiceAvailabilityForAddress ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns serviceability information for a given address_id
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, address_id
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | identifier, class_number, servicable, description, service_type_id, service_type_name, service_type_description
| |
| − | | |
| − | ==== getServiceAvailabilityForGnaf ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns serviceability information for a given gnaf_pid
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, gnaf_pid
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | identifier, class_number, servicable, description, service_type_id, service_type_name, service_type_description
| |
| − | | |
| − | ==== getPortAvailabilityForAddress ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Tells if there is an available port for the given address
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, address_id, carrier_id, minimum_class_number
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | gnaf_pid
| |
| − | | |
| − | ==== getServiceTypesForAddress ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns a list of service types available for an address
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, address_id, carrier_id, minimum_class_number
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | service_id, type_name, port_available
| |
| − | | |
| − | ==== getNumberOfPortsForAddress ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns the number of free and used ports for the given address
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, address_id, carrier_id
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | free_ports, used_ports
| |
| − | | |
| − | ==== getPortInformationForAddress ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | Returns information about ports at a given address
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, address_id, carrier_id
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | service_id, type_name, port_type, port_name
| |
| − | | |
| − | ==== getServiceBoltOnSubscriptionPeriodsByService ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | For a given service_id, returns a list of service subscription bolt on periods.
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, service_id
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | service_bolt_on_subscr_id, bolt_on_subscr_per_start_date, bolt_on_subscr_per_end_date, service_subscription_id, service_subscr_period_start, service_subscr_period_end, service_bolt_on_plan_name, service_plan_name, value_normal, value_actual, value_type
| |
| − | | |
| − | ==== viewUsageByServiceSubscriptionPeriodId ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | | |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, service_sub_period_id, includeBoltOn
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | service_subscription_period_id, service_bolt_on_subscription_period_id, package_period_id, date_started, date_ended, fnn_destination, tariff_id, tariff_name, rated_tariff_id, rated_tariff_name, duration, rated_tariff_type_id, rated_tariff_type_name, destination_description, package_plan_id, call_reference_id, package_plan_name_internal, package_plan_name_external, rated_amount, charged_amount, invoiced_amount, invoiced_tax_amount, time_band_id, time_band_name, rated_tax_type_id, rated_tax_type_name, rated_tax_type_percentage
| |
| − | | |
| − | ==== viewUsageByServiceBoltOnSubscriptionPeriodId ====
| |
| − | | |
| − | ====== Description ======
| |
| − | | |
| − | ====== Input ======
| |
| − | | |
| − | username, password, service_bolton_sub_period_id
| |
| − | | |
| − | ====== Output ======
| |
| − | | |
| − | == 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
| |
