Go to full article


Overview

This API call allows you to set the object property "Service Details for Invoice" on a service.

WSDL

https://api.emersion.com.au/Services.wsdl

Operation name

AddServiceDetailsForInvoice



Business Rules

  • Service should exist
  • Parent account of service should be equal to the account associated with the calling api user.
  • Property type 'AddServiceDetailsForInvoice' must be mapped to the service type associated with the service
  • Vanity Description
  • Value must honour field length limits




SOAP Example


API Call
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:AddServiceDetailsForInvoice>
         <urn:ServiceID>1280750</urn:ServiceID>
         <urn:ServiceDetailsForInvoice>Main Office</urn:ServiceDetailsForInvoice>
      </urn:AddServiceDetailsForInvoice>
   </soapenv:Body>
</soapenv:Envelope>
API Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">
   <SOAP-ENV:Body>
      <ns1:AddServiceDetailsForInvoiceResponse/>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Field Descriptions

All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information..

NameDescriptionRequired?Field Type

Character

limit

Values 
ServiceID
Service that the attribute will apply to.YesInt

1280750



ServiceDetailsForInvoice
Additional details to apply to Invoice.  These details will show on line items when cardlines from Emersion are pushed to the Xero platform.YesString
'Main Office'



Error Handling


Error MessageDescription
Invalid ServiceID
Either the service doesn't exist, or you don't have permission to modify attributes set against it, because the parent account of the service is not the same as the account associated with the API caller.
ServiceType #999 associated with ServiceID 1280748 is not eligible to set ServiceDetailsForInvoice
The Service Type does not permit setting an attribute of this type.  Please contact Emersion Support if you have a service type where setting this attribute is required.