Supplier
A business the retailer buys from.
Area: Purchase and transfer documents · Why it is here: retail core · Fields: 38
iVendNext's own description: Supplier of Goods or Services.
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Supplier?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/Supplier/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one (the required fields first), if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Supplier" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"supplier_name": …, "supplier_type": …}'
Change one with PUT /api/resource/Supplier/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Samples that use it
s22_customer_loyalty · s40_expiry_recall · s42_optical_prescriptions
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Series | naming_series |
Select | one of: SUP-.YYYY.- | |||
| Supplier Name | supplier_name |
Data | yes | |||
| Country | country |
Link | Country | |||
| Supplier Group | supplier_group |
Link | Supplier Group | |||
| Supplier Type | supplier_type |
Select | yes | one of: Company, Individual, Partnership | ||
| Is Transporter | is_transporter |
Check | ||||
| Image | image |
Attach Image | yes | |||
| Billing Currency | default_currency |
Link | Currency | |||
| Default Company Bank Account | default_bank_account |
Link | Bank Account | |||
| Price List | default_price_list |
Link | Price List | |||
| Is Internal Supplier | is_internal_supplier |
Check | ||||
| Represents Company | represents_company |
Link | Company | |||
| Allowed To Transact With | companies |
Table | Allowed To Transact With | |||
| Supplier Details | supplier_details |
Text | ||||
| Website | website |
Data | ||||
| Print Language | language |
Link | Language | |||
| Tax ID | tax_id |
Data | ||||
| Tax Category | tax_category |
Link | Tax Category | |||
| Tax Withholding Category | tax_withholding_category |
Link | Tax Withholding Category | |||
| Supplier Primary Address | supplier_primary_address |
Link | Address | |||
| Primary Address | primary_address |
Text | yes | |||
| Supplier Primary Contact | supplier_primary_contact |
Link | Contact | |||
| Mobile No | mobile_no |
Read Only | yes | |||
| Email Id | email_id |
Read Only | yes | |||
| Default Payment Terms Template | payment_terms |
Link | Payment Terms Template | |||
| Accounts | accounts |
Table | Party Account | |||
| Allow Purchase Invoice Creation Without Purchase Order | allow_purchase_invoice_creation_without_purchase_order |
Check | ||||
| Allow Purchase Invoice Creation Without Purchase Receipt | allow_purchase_invoice_creation_without_purchase_receipt |
Check | ||||
| Is Frozen | is_frozen |
Check | ||||
| Disabled | disabled |
Check | ||||
| Warn RFQs | warn_rfqs |
Check | yes | yes | ||
| Warn POs | warn_pos |
Check | yes | yes | ||
| Prevent RFQs | prevent_rfqs |
Check | yes | yes | ||
| Prevent POs | prevent_pos |
Check | yes | yes | ||
| Block Supplier | on_hold |
Check | ||||
| Hold Type | hold_type |
Select | one of: All, Invoices, Payments | |||
| Release Date | release_date |
Date | ||||
| Supplier Portal Users | portal_users |
Table | Portal User |
Table: Allowed To Transact With
The rows of companies. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Company | company |
Link | yes | Company |
Table: Party Account
The rows of accounts. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Company | company |
Link | yes | Company | ||
| Default Account | account |
Link | Account | |||
| Advance Account | advance_account |
Link | Account |
Table: Portal User
The rows of portal_users. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| User | user |
Link | yes | User |