GET Supplier/Get/{id}

Gets the specified Supplier based on the identifier. Excludes records where Personal Information was cleared.

Request Information

URI Parameters

Name	Type	Additional information	Description
id	integer	Required	The identifier.

Body Parameters

None.

Response Information

Resource Description

Supplier

Name	Type	Additional information	Description
ID	integer	None.
Name	string	None.
Category	Supplier Category	None.
TaxReference	string	None.
ContactName	string	None.
Telephone	string	None.
Fax	string	None.
Mobile	string	None.
Email	string	None.
WebAddress	string	None.
Active	bool	None.
IsObfuscated	bool	None.
Balance	decimal	Read Only / System Generated
CreditLimit	decimal	None.
PostalAddress01	string	None.
PostalAddress02	string	None.
PostalAddress03	string	None.
PostalAddress04	string	None.
PostalAddress05	string	None.
DeliveryAddress01	string	None.
DeliveryAddress02	string	None.
DeliveryAddress03	string	None.
DeliveryAddress04	string	None.
DeliveryAddress05	string	None.
AutoAllocateToOldestInvoice	nullable bool	None.
TextField1	string	None.
TextField2	string	None.
TextField3	string	None.
NumericField1	nullable decimal	None.
NumericField2	nullable decimal	None.
NumericField3	nullable decimal	None.
YesNoField1	bool	None.
YesNoField2	bool	None.
YesNoField3	bool	None.
DateField1	nullable date	None.
DateField2	nullable date	None.
DateField3	nullable date	None.
AccountingAgreement	bool	None.
HasSpecialCountryTaxActivity	bool	Read Only / System Generated
Modified	nullable date	Read Only / System Generated
Created	date	Read Only / System Generated
BusinessRegistrationNumber	string	None.
RMCDApprovalNumber	string	None.
TaxStatusVerified	nullable date	None.
CurrencyId	nullable integer	None.
CurrencySymbol	string	None.
HasActivity	bool	Read Only / System Generated
DefaultDiscountPercentage	nullable decimal	None.
DefaultTaxTypeId	nullable integer	None.
DefaultTaxType	Tax Type	None.
DueDateMethodId	nullable integer	None.
DueDateMethodValue	nullable integer	None.
SubjectToDRCVat	bool	None.	This will only be used by Suppliers in South Africa. DRC Vat is only subject to Registered Vat Vendors.

Response Formats

application/json, text/json

Sample:

{
  "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": "efe8d389-16a3-4e24-8114-6024fd692965",
    "CompanyId": 9
  },
  "DueDateMethodId": 1,
  "DueDateMethodValue": 1,
  "SubjectToDRCVat": true,
  "ID": 38
}