Suppliers

The Suppliers resource allows Suppliers to be listed and viewed. An individual Supplier’s details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI. Here are some example URIs:

/Suppliers - returns a list of all Suppliers;
/Suppliers/E6E8163F-6911-40e9-B740-90E5A0A3A996 - returns details of a particular Supplier;

The full range of URIs and HTTP Verbs supported are:

Operation	HTTP Action
List all Suppliers	GET `/Suppliers`
View any Supplier	GET `/Suppliers/{id}`

GET Suppliers

These filters can be used with the GET Suppliers endpoint:

Filter	Description
`pageSize`	Specifies the page size for pagination. Default page size is 200 suppliers. Note: Requesting large numbers of suppliers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
`supplierCode`	Only return suppliers that start with the specific supplier code
`contactEmail`	Only return suppliers that have a contact email that starts with the specified email address
`modifiedSince`	Returns suppliers created or edited after a specified date. For example: modifiedSince=2016-07-01, modifiedSince=2016-07-01T19:54:18.060.

Filters are used by adding the filter and value to the URI: /Suppliers?supplierCode=ACME

Available Fields for Supplier:

Property	Type	Length	Notes
Addresses	Address collection		You can have the following Address Types: Postal and Physical
BankAccount	String
BankBranch	String
BankName	String
DDINumber	String
Email	String
Currency	Currency
FaxNumber	String
GSTVATNumber	String
Guid	Guid		Unique identifier. Can only be set when adding a record.
CreatedBy	String	50
CreatedOn	DateTime
LastModifiedBy	String	50
LastModifiedOn	Nullable DateTime
LeadTimeDays	Nullable Decimal
MobileNumber	String
Notes	String
Obsolete	Boolean
PhoneNumber	String
PurchaseOrderCostDistributionMethod	String	15
SupplierCode	String		Unique code. Can only be set when adding a record.
SupplierName	String
Taxable	Nullable Boolean	`true`,`false`
TaxRate	Nullable Decimal
TollFreeNumber	String
Website	String
XeroContactId	String

Available Fields for Address:

Property	Type	Length
AddressType	String	20
AddressName	String	500
StreetAddress	String	500
StreetAddress2	String	500
Suburb	String	500
City	String	500
Region	String	500
Country	String	100
PostalCode	String	500

Examples for Request GET `/Suppliers`

show xml example

 
<?xml version="1.0"?>
<Suppliers xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
  <Supplier>
    <Guid>8cc42596-cd15-47af-9301-2d7c967a49c1</Guid>
    <SupplierCode>PPP01</SupplierCode>
    <SupplierName>Paul's Produce &amp; Particulars</SupplierName>
    <Taxable>true</Taxable>
    <LastModifiedOn>2016-03-29T02:32:20.833</LastModifiedOn>
    <PurchaseOrderCostDistributionMethod>Volume</PurchaseOrderCostDistributionMethod>
    <Addresses>
        <Address>
            <AddressType>Postal</AddressType>
            <AddressName>Office</AddressName>
            <StreetAddress>12 Arran Drive</StreetAddress>
            <Suburb>Helensville</Suburb>
            <City>Auckland</City>
            <Country>New Zealand</Country>
            <PostalCode>0762</PostalCode>
        </Address>
        <Address>
            <AddressType>Physical</AddressType>
            <AddressName>Warehouse</AddressName>
            <StreetAddress>6 Blue Lane</StreetAddress>
            <Suburb>Greenlane</Suburb>
            <City>Auckland</City>
            <Country>New Zealand</Country>
            <PostalCode>9876</PostalCode>
        </Address>
    </Addresses>
    <Obsolete>false</Obsolete>
    <LeadTimeDays>22</LeadTimeDays>
    <TaxRate>0.150000</TaxRate>
  </Supplier>
  <Supplier>
    <Guid>a2d8ebff-6031-4421-b546-683084848915</Guid>
    <SupplierCode>DEPOT</SupplierCode>
    <SupplierName>Depot Dadello</SupplierName>
    <Taxable>true</Taxable>
    <LastModifiedOn>2016-03-29T02:32:20.833</LastModifiedOn>
  </Supplier>
  <Supplier>
    <Guid>cd850acc-c270-4470-bb76-85c356791d26</Guid>
    <SupplierCode>BERRY</SupplierCode>
    <SupplierName>Berry Boutique</SupplierName>
    <Taxable>true</Taxable>
    <LastModifiedOn>2016-03-29T02:32:20.837</LastModifiedOn>
  </Supplier>
  <Supplier>
    <Guid>34d960ad-121a-4f8f-a4f6-5e0fc69e5b09</Guid>
    <SupplierCode>RANMEGA</SupplierCode>
    <SupplierName>Ranwell Megastore</SupplierName>
    <Taxable>true</Taxable>
    <LastModifiedOn>2016-03-29T02:32:20.837</LastModifiedOn>
  </Supplier>
  <Supplier>
    <Guid>a07d2abb-06b1-434d-bfd5-547ca68fe1c6</Guid>
    <SupplierCode>TRISH</SupplierCode>
    <SupplierName>Trisha's Trinkets</SupplierName>
    <Taxable>true</Taxable>
    <LastModifiedOn>2016-03-29T02:32:20.84</LastModifiedOn>
  </Supplier>
</Suppliers>

show json example

{
    "Items": [
        {
            "Guid": "8cc42596-cd15-47af-9301-2d7c967a49c1",
            "SupplierCode": "PPP01",
            "SupplierName": "Paul's Produce & Particulars",
            "GSTVATNumber": null,
            "BankName": null,
            "BankBranch": null,
            "BankAccount": null,
            "Website": null,
            "PhoneNumber": null,
            "FaxNumber": null,
            "MobileNumber": null,
            "DDINumber": null,
            "TollFreeNumber": null,
            "PurchaseOrderCostDistributionMethod": "Volume",
            "Email": null,
            "Notes": null,
            "Taxable": true,
            "XeroContactId": null,
            "LastModifiedOn": "/Date(1459218740833)/",
            "Addresses": [
                {
                    "AddressType": "Postal",
                    "AddressName": "Office",
                    "StreetAddress": "12 Arran Drive",
                    "StreetAddress2": null,
                    "Suburb": "Helensville",
                    "City": "Auckland",
                    "Region": null,
                    "Country": "New Zealand",
                    "PostalCode": "0762"
                },
                {
                    "AddressType": "Physical",
                    "AddressName": "Warehouse",
                    "StreetAddress": "6 Blue Lane",
                    "StreetAddress2": null,
                    "Suburb": "Greenlane",
                    "City": "Auckland",
                    "Region": null,
                    "Country": "New Zealand",
                    "PostalCode": "9876"
                }
            ],
            "Obsolete": false,
            "LeadTimeDays": null,
            "TaxRate": 0.150000
        },
        {
            "Guid": "a2d8ebff-6031-4421-b546-683084848915",
            "SupplierCode": "DEPOT",
            "SupplierName": "Depot Dadello",
            "GSTVATNumber": null,
            "BankName": null,
            "BankBranch": null,
            "BankAccount": null,
            "Website": null,
            "PhoneNumber": null,
            "FaxNumber": null,
            "MobileNumber": null,
            "DDINumber": null,
            "TollFreeNumber": null,
            "Email": null,
            "Notes": null,
            "Taxable": true,
            "XeroContactId": null,
            "LastModifiedOn": "/Date(1459218740833)/"
        },
        {
            "Guid": "cd850acc-c270-4470-bb76-85c356791d26",
            "SupplierCode": "BERRY",
            "SupplierName": "Berry Boutique",
            "GSTVATNumber": null,
            "BankName": null,
            "BankBranch": null,
            "BankAccount": null,
            "Website": null,
            "PhoneNumber": null,
            "FaxNumber": null,
            "MobileNumber": null,
            "DDINumber": null,
            "TollFreeNumber": null,
            "Email": null,
            "Notes": null,
            "Taxable": true,
            "XeroContactId": null,
            "LastModifiedOn": "/Date(1459218740837)/"
        },
        {
            "Guid": "34d960ad-121a-4f8f-a4f6-5e0fc69e5b09",
            "SupplierCode": "RANMEGA",
            "SupplierName": "Ranwell Megastore",
            "GSTVATNumber": null,
            "BankName": null,
            "BankBranch": null,
            "BankAccount": null,
            "Website": null,
            "PhoneNumber": null,
            "FaxNumber": null,
            "MobileNumber": null,
            "DDINumber": null,
            "TollFreeNumber": null,
            "Email": null,
            "Notes": null,
            "Taxable": true,
            "XeroContactId": null,
            "LastModifiedOn": "/Date(1459218740837)/"
        },
        {
            "Guid": "a07d2abb-06b1-434d-bfd5-547ca68fe1c6",
            "SupplierCode": "TRISH",
            "SupplierName": "Trisha's Trinkets",
            "GSTVATNumber": null,
            "BankName": null,
            "BankBranch": null,
            "BankAccount": null,
            "Website": null,
            "PhoneNumber": null,
            "FaxNumber": null,
            "MobileNumber": null,
            "DDINumber": null,
            "TollFreeNumber": null,
            "Email": null,
            "Notes": null,
            "Taxable": true,
            "XeroContactId": null,
            "LastModifiedOn": "/Date(1459218740840)/"
        }
    ]
}