AP Supplier

URL	Verbs	Function
/Supplier	GET	Query a list of all Suppliers
/Supplier/<code>	GET	Query a single Supplier
/Supplier	POST	Create a new supplier
/Supplier/<code>	POST	Update an existing Supplier

Updated for versions 2018.3 and later to handle the full supplier detail.

Supported modifiers

Query String	Definition	Sample	Available
modifiedSince	Return Suppliers modified since a particular date and time	modifiedSince=2013-02-28T16:45:00
treeName and treeBranch	Return a list of Suppliers assigned to a nominated branch of a nominated tree	treeName=Colour-AUS&treeBranch=Blue
taxReference	Return a list of Suppliers that match the the tax reference passed in (ie lookup by ABN)	taxReference=24454342
status	Return a list of Suppliers for a particulat status	status=Active
isActive	Return a list of Suppliers deemed Active in Greentree	isActive=true
respectAdvancedSecurityForUser	Return only Suppliers that are accessible to the nominated User based on Advanced Security	respectAdvancedSecurityForUser=Susan Smith	2020.3

Security Linked Menu

Menu Item	Located
Supplier Maintenance	Data Entry / Accounts Payable

Sample XML Response

<?xml version="1.0" encoding="UTF-8"?>
<Supplier>
    <Code>2000</Code>
    <Alpha>CPMNX</Alpha>
    <Name>Computer and Parts Maintenance</Name>
    <OidString>2578.53</OidString>
    <Edition>202</Edition>
    <ModifiedTimeStamp>2018-10-10T12:27:46</ModifiedTimeStamp>
    <ModifiedUser>SUPER</ModifiedUser>
    <EntryTimeStamp>2007-07-21T11:47:49</EntryTimeStamp>
    <EntryUser/>
    <IsActive>false</IsActive>
    <AlternatePayeeName>Ralph</AlternatePayeeName>
    <BankAccount>
        <AccountNo>643117125268</AccountNo>
        <Branch/>
        <Name/>
        <Suffix/>
        <FullBankAccount>643117125268</FullBankAccount>
    </BankAccount>
    <CreditorsControlAccount>33.*.*</CreditorsControlAccount>
    <DiscountRate>12.00</DiscountRate>
    <GLExpenseAccountNo>14.*.*</GLExpenseAccountNo>
    <InvoiceForm>AP Invoice</InvoiceForm>
    <IsChild>false</IsChild>
    <IsPayingInvoicesSeparately>false</IsPayingInvoicesSeparately>
    <IsPrintSupplierPartNum>true</IsPrintSupplierPartNum>
    <IsReportTaxablePayments>false</IsReportTaxablePayments>
    <IsTPRIndividual>false</IsTPRIndividual>
    <IsUseAdvInvoicing>true</IsUseAdvInvoicing>
    <IsUsingAlternatePayeeAddress>true</IsUsingAlternatePayeeAddress>
    <IsUsingAlternatePayeeName>false</IsUsingAlternatePayeeName>
    <IsUsingBuyerCreatedInvoice>true</IsUsingBuyerCreatedInvoice>
    <IsUsingWithholdingTax>false</IsUsingWithholdingTax>
    <IsSingleAttachmentPereReportingEmail>false</IsSingleAttachmentPereReportingEmail>
    <BPayBillerCode>123</BPayBillerCode>
    <BPayReference>5678</BPayReference>
    <IsBPayDefaultReferenceFromInvoice>true</IsBPayDefaultReferenceFromInvoice>
    <IsBPayFixedReference>true</IsBPayFixedReference>
    <Country>AUS</Country>
    <PayeeAddress>
        <Contact/>
        <Address1>Factory 123</Address1>
        <Address2>663 Luck Street2</Address2>
        <Address3>Smithfield</Address3>
        <Suburb>Mulgrave South</Suburb>
        <Postcode>3173</Postcode>
        <State>NSW</State>
        <Country>AUS</Country>
        <TZone>+11:00</TZone>
        <PhoneBH>(03) 9586 5233</PhoneBH>
        <PhoneAH>(03) 9586 5237</PhoneAH>
        <Fax>(03) 9584 5230</Fax>
        <Email>sales@cpm.com</Email>
        <Web>www.myaddres.com</Web>
        <Mobile>0410 007 334</Mobile>
    </PayeeAddress>
    <SecurityTeam>HR Weekly</SecurityTeam>
    <BalanceType>Balance Forward</BalanceType>
    <Branch>02</Branch>
    <AnalysisCode>ADVE</AnalysisCode>
    <Calendar>JUN</Calendar>
    <Currency>AUD</Currency>
    <DeliveryMethod>Courier-Road</DeliveryMethod>
    <CreditNoteType>AP Credit</CreditNoteType>
    <InvoiceType>Receipt</InvoiceType>
    <PaymentTerm>60 Days from Invoice Date</PaymentTerm>
    <DiscountType>Percentage of Total</DiscountType>
    <PurchaseOrders>
        <ClearingAccount>21.*.*</ClearingAccount>
        <HoldStatus>Entered</HoldStatus>
        <Form>PO Purchase Order - L</Form>
        <VarianceAccount>15.*.*</VarianceAccount>
        <DeliveryMethod>Email</DeliveryMethod>
        <RecipientAddress>peter@email.com</RecipientAddress>
    </PurchaseOrders>
    <PaymentMethod>BPay</PaymentMethod>
    <RemittanceDeliveryMethod>Print</RemittanceDeliveryMethod>
    <Status>Inactive</Status>
    <TaxCode>Input Taxed</TaxCode>
    <TaxType>Inclusive</TaxType>
    <Notes>Stickier Notes</Notes>
    <PayeeRef1>Payment from2</PayeeRef1>
    <PayeeRef2>e-Computers3</PayeeRef2>
    <PayeeRef3>Miss 4</PayeeRef3>
    <RemittanceRecipientAddress>steve@emailc.om</RemittanceRecipientAddress>
    <RetentionBalance>0.00</RetentionBalance>
    <TaxControlAccount>17.*.*</TaxControlAccount>
    <TotalHoldAmount>7524.11</TotalHoldAmount>
    <TotalOutstandingBalance>38665.12</TotalOutstandingBalance>
    <TransitABANumber/>
    <TaxActivity/>
    <TaxExemption/>
    <ExemptionEnd/>
    <ExemptionStart/>
    <TaxRate>0</TaxRate>
    <TaxReference>72 456 379 609</TaxReference>
    <TaxReturnEnd/>
    <TaxReturnStart/>
    <TaxReturnName/>
    <Address>
        <Contact>Georgie</Contact>
        <Address1>Factory 123</Address1>
        <Address2>663 Luck Street2</Address2>
        <Address3>Smithfield</Address3>
        <Suburb>Mulgrave South</Suburb>
        <Postcode>3173</Postcode>
        <State>NSW</State>
        <Country>AUS</Country>
        <TZone>+11:00</TZone>
        <PhoneBH>(03) 9586 5233</PhoneBH>
        <PhoneAH>(03) 9586 5237</PhoneAH>
        <Fax>(03) 9584 5230</Fax>
        <Email>sales@cpm.com</Email>
        <Web>www.myaddres.com</Web>
        <Mobile>0410 007 334</Mobile>
    </Address>
    <UserDefinedFields collection='true' count='2'>
        <UserDefinedField>
            <Name>Review Date</Name>
            <Type>Date</Type>
            <Value>2009-02-02</Value>
        </UserDefinedField>
        <UserDefinedField>
            <Name>UBD Ref</Name>
            <Type>String</Type>
            <Value>12 E43</Value>
        </UserDefinedField>
    </UserDefinedFields>
    <Trees collection='true' count='2'>
        <Tree>
            <Name>Region-AUS</Name>
            <IsMandatory>false</IsMandatory>
            <Value>Tasmania</Value>
            <Path>Australia\Tasmania</Path>
            <ShortCode>TAS</ShortCode>
        </Tree>
        <Tree>
            <Name>Supplier Type-AUS</Name>
            <IsMandatory>false</IsMandatory>
            <Value>Hardware Wholesalers</Value>
            <Path>Hardware Wholesalers</Path>
            <ShortCode>HARDWARE</ShortCode>
        </Tree>
    </Trees>
</Supplier>