With our community of partners, you can get expert advice and training so you can be up and running in no time! SETUP PARTNERS

API Documentation

Supplier Methods

Method Description
GET list Return a list of all suppliers
GET get/[uuid] Detailed information for a specific supplier
POST add Add a supplier and contacts
PUT update Update a suppliers details
PUT archive Archive a supplier
POST delete Delete a supplier
GET contact/[uuid] Detailed information for a specific contact
PUT contact/[uuid] Update a contacts details
POST contact add a contact to a supplier

GET list

Return a list of all suppliers

Parameters

Parameter Required? Description
detailed=true Optional Return detailed information of supplier. See GET get/[identifier] method for example of detailed supplier response.

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/supplier.api/list

Example Response

<Response>
  <Status>OK</Status> 
  <Suppliers>
    <Supplier>
      <UUID>0c2b4b07-79c0-419a-9329-6a1b5cef84bc</UUID>
      <Name>XYZ Australia, NZ Business Unit</Name> 
      <Address /> 
      <City /> 
      <Region /> 
      <PostCode /> 
      <Country /> 
      <PostalAddress>
         Level 32, PWC Building 
         188 Quay Street
         Auckland Central
      </PostalAddress> 
      <PostalCity>Auckland</PostalCity> 
      <PostalRegion /> 
      <PostalPostCode>1001</PostalPostCode>  
      <PostalCountry /> 
      <Phone /> 
      <Fax /> 
      <Website /> 
      <Contacts>
        <Contact>
          <UUID>bb9cb1cb-0646-431b-83f8-192d6dd3b5d1</UUID>
          <Name>Samantha Benecke</Name> 
          <Mobile /> 
          <Email /> 
          <Phone /> 
          <Position /> 
        </Contact>
      </Contacts>
    </Supplier>
    <Supplier>
      <UUID>b2a02da8-f13a-4338-aa1c-c06a7e67805c</UUID> 
      <Name>A. Dutchess</Name> 
      <Address /> 
      <City /> 
      <Region /> 
      <PostCode /> 
      <Country /> 
      <PostalAddress>P O Box 123</PostalAddress> 
      <PostalCity>Wellington</PostalCity> 
      <PostalRegion /> 
      <PostalPostCode>6011</PostalPostCode>  
      <PostalCountry />
      <Phone /> 
      <Fax /> 
      <Website /> 
      <Contacts /> 
    </Supplier>
  </Suppliers>
</Response>

GET get/[uuid]

Detailed information for a specific supplier

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/supplier.api/get/b9bf52d8-af3d-45bb-b81c-2d44802788c0

Example Response

<Response>
  <Status>OK</Status> 
  <Supplier>
    <UUID>b9bf52d8-af3d-45bb-b81c-2d44802788c0</UUID>
    <Name>Acmer Pty Ltd</Name> 
    <Address /> 
    <City /> 
    <Region /> 
    <PostCode /> 
    <Country /> 
    <PostalAddress>
       Level 32, PWC Building 
       188 Quay Street
       Auckland Central
    </PostalAddress> 
    <PostalCity>Auckland</PostalCity> 
    <PostalRegion /> 
    <PostalPostCode>1001</PostalPostCode>  
    <PostalCountry /> 
    <Phone>(02) 1723 5265</Phone> 
    <Fax /> 
    <Website /> 
    <Contacts>
      <Contact>
        <UUID>7de6821f-973b-44dd-9225-fc0ad4a7b838</UUID>
        <Name>Wyett E Coyote</Name> 
        <Mobile /> 
        <Email /> 
        <Phone /> 
        <Position /> 
      </Contact>
    </Contacts>
    <Notes>
      <Note>
        <Title>note title</Title> 
        <Text>subject of the note</Text> 
        <Folder /> 
        <Date>2008-09-12T13:00:00</Date> 
        <CreatedBy>Jo Bloggs</CreatedBy>
      </Note>
    </Notes>
  </Supplier>
</Response>

POST add

Add a supplier and contacts

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/supplier.api/add

Example Message

<Supplier>
  <Name>Bloggs Electrical Ltd</Name>
  <Address></Address>  <!-- optional -->   
  <City></City>  <!-- optional -->   
  <Region></Region>  <!-- optional -->   
  <PostCode></PostCode>  <!-- optional -->   
  <Country></Country>  <!-- optional -->   
  <PostalAddress></PostalAddress>  <!-- optional -->   
  <PostalCity></PostalCity>  <!-- optional -->   
  <PostalRegion></PostalRegion>  <!-- optional -->   
  <PostalPostCode></PostalPostCode>  <!-- optional -->   
  <PostalCountry></PostalCountry>  <!-- optional -->   
  <Phone></Phone>  <!-- optional -->   
  <Fax></Fax>  <!-- optional -->   
  <WebSite></WebSite>  <!-- optional -->   
  <Contacts>
    <Contact>
      <Name>Jo Bloggs</Name>   
      <Phone></Phone>  <!-- optional -->   
      <Mobile></Mobile>  <!-- optional -->   
      <Email></Email>  <!-- optional -->   
      <Position></Position>  <!-- optional -->   
    </Contact>
  </Contacts>
</Supplier>

The response will include the detailed information of the supplier as per the GET get/[identifier] method

PUT update

Update a suppliers details

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/supplier.api/update

Example Message

<Supplier>
  <UUID>0f6b9149-4e8b-4684-97f0-4de669dfb470</UUID>
  <Name>Bloggs Electrical Ltd</Name>
  <Address></Address>  <!-- optional -->   
  <City></City>  <!-- optional -->   
  <Region></Region>  <!-- optional -->   
  <PostCode></PostCode>  <!-- optional -->   
  <Country></Country>  <!-- optional -->   
  <PostalAddress></PostalAddress>  <!-- optional -->   
  <PostalCity></PostalCity>  <!-- optional -->   
  <PostalRegion></PostalRegion>  <!-- optional -->   
  <PostalPostCode></PostalPostCode>  <!-- optional -->   
  <PostalCountry></PostalCountry>  <!-- optional -->   
  <Phone></Phone>  <!-- optional -->   
  <Fax></Fax>  <!-- optional -->   
  <WebSite></WebSite>  <!-- optional -->   
  <ReferralSourcee></ReferralSource>  <!-- optional -->   
</Supplier>

PUT archive

Archive a supplier

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/supplier.api/archive

Example Message

<Supplier>
  <UUID>0f6b9149-4e8b-4684-97f0-4de669dfb470</UUID>
</Supplier>

The response will include the detailed information of the supplier as per the GET get/[identifier] method

POST delete

Delete a supplier

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/supplier.api/delete

Example Message

<Supplier>
  <UUID>0f6b9149-4e8b-4684-97f0-4de669dfb470</UUID>
</Supplier>

The response will include the detailed information of the supplier as per the GET get/[identifier] method

GET contact/[uuid]

Detailed information for a specific contact

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/supplier.api/contact/7de6821f-973b-44dd-9225-fc0ad4a7b838

Example Response

<Response>
  <Status>OK</Status> 
  <Contact>
    <UUID>7de6821f-973b-44dd-9225-fc0ad4a7b838</UUID>
    <Name>Wyett E Coyote</Name> 
    <Mobile /> 
    <Email /> 
    <Phone /> 
    <Position /> 
  </Contact>
</Response>

PUT contact/[uuid]

Update a contacts details

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/supplier.api/contact/7de6821f-973b-44dd-9225-fc0ad4a7b838

Example Message

<Contact>
  <Name>Wyett E Coyote</Name> 
  <Mobile /> 
  <Email /> 
  <Phone /> 
  <Position /> 
</Contact>

The response will include the detailed information of the contact as per the GET contact/[identifier] method

POST contact

add a contact to a supplier

EXAMPLE URL

https://api.xero.com/workflowmax/3.0/supplier.api/contact

Example Message

<Contact>
  <Supplier>
    <UUID>000e9321-72a1-4023-bcc3-9219fefa831e</UUID>
  </Supplier>
  <Name>Wyett E Coyote</Name> 
  <Mobile /> 
  <Email /> 
  <Phone /> 
  <Position /> 
</Contact>

The response will include the detailed information of the contact as per the GET contact/[identifier] method