GET Supplier/Get
Gets a List of Suppliers. Excludes records where Personal Information was cleared.
Request Information
This method supports OData queries.
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
This collection is wrapped in a paging response object.
Paging response of SupplierName | Type | Additional information | Description |
---|---|---|---|
TotalResults | integer |
None. |
|
ReturnedResults | integer |
None. |
|
Results | Collection of Supplier |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalResults": 1, "ReturnedResults": 2, "Results": [ { "Name": "sample string 1", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2024-11-15", "Created": "2024-11-15" }, "TaxReference": "sample string 2", "ContactName": "sample string 3", "Telephone": "sample string 4", "Fax": "sample string 5", "Mobile": "sample string 6", "Email": "sample string 7", "WebAddress": "sample string 8", "Active": true, "IsObfuscated": true, "Balance": 11.0, "CreditLimit": 12.0, "PostalAddress01": "sample string 13", "PostalAddress02": "sample string 14", "PostalAddress03": "sample string 15", "PostalAddress04": "sample string 16", "PostalAddress05": "sample string 17", "DeliveryAddress01": "sample string 18", "DeliveryAddress02": "sample string 19", "DeliveryAddress03": "sample string 20", "DeliveryAddress04": "sample string 21", "DeliveryAddress05": "sample string 22", "AutoAllocateToOldestInvoice": true, "TextField1": "sample string 23", "TextField2": "sample string 24", "TextField3": "sample string 25", "NumericField1": 1.0, "NumericField2": 1.0, "NumericField3": 1.0, "YesNoField1": true, "YesNoField2": true, "YesNoField3": true, "DateField1": "2024-11-15", "DateField2": "2024-11-15", "DateField3": "2024-11-15", "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "Modified": "2024-11-15", "Created": "2024-11-15", "BusinessRegistrationNumber": "sample string 33", "RMCDApprovalNumber": "sample string 34", "TaxStatusVerified": "2024-11-15", "CurrencyId": 1, "CurrencySymbol": "sample string 35", "HasActivity": true, "DefaultDiscountPercentage": 1.0, "DefaultTaxTypeId": 1, "DefaultTaxType": { "ID": 1, "Name": "sample string 2", "Percentage": 3.1, "IsDefault": true, "HasActivity": true, "IsManualTax": true, "Active": true, "Created": "2024-11-15", "Modified": "2024-11-15", "TaxTypeDefaultUID": "48f15ba3-20af-4813-bb07-d965e0cb1a70", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "SubjectToDRCVat": true, "ID": 38 }, { "Name": "sample string 1", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2024-11-15", "Created": "2024-11-15" }, "TaxReference": "sample string 2", "ContactName": "sample string 3", "Telephone": "sample string 4", "Fax": "sample string 5", "Mobile": "sample string 6", "Email": "sample string 7", "WebAddress": "sample string 8", "Active": true, "IsObfuscated": true, "Balance": 11.0, "CreditLimit": 12.0, "PostalAddress01": "sample string 13", "PostalAddress02": "sample string 14", "PostalAddress03": "sample string 15", "PostalAddress04": "sample string 16", "PostalAddress05": "sample string 17", "DeliveryAddress01": "sample string 18", "DeliveryAddress02": "sample string 19", "DeliveryAddress03": "sample string 20", "DeliveryAddress04": "sample string 21", "DeliveryAddress05": "sample string 22", "AutoAllocateToOldestInvoice": true, "TextField1": "sample string 23", "TextField2": "sample string 24", "TextField3": "sample string 25", "NumericField1": 1.0, "NumericField2": 1.0, "NumericField3": 1.0, "YesNoField1": true, "YesNoField2": true, "YesNoField3": true, "DateField1": "2024-11-15", "DateField2": "2024-11-15", "DateField3": "2024-11-15", "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "Modified": "2024-11-15", "Created": "2024-11-15", "BusinessRegistrationNumber": "sample string 33", "RMCDApprovalNumber": "sample string 34", "TaxStatusVerified": "2024-11-15", "CurrencyId": 1, "CurrencySymbol": "sample string 35", "HasActivity": true, "DefaultDiscountPercentage": 1.0, "DefaultTaxTypeId": 1, "DefaultTaxType": { "ID": 1, "Name": "sample string 2", "Percentage": 3.1, "IsDefault": true, "HasActivity": true, "IsManualTax": true, "Active": true, "Created": "2024-11-15", "Modified": "2024-11-15", "TaxTypeDefaultUID": "48f15ba3-20af-4813-bb07-d965e0cb1a70", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "SubjectToDRCVat": true, "ID": 38 } ] }