ASCI API - Vendors

Vendors module page - how it works, an interactive test form, and the endpoint reference, all in one place. Set your tenant API Key in the Setup block below; every request sends the ApiKey header. See All Forms for the combined surface or Home for the module index.

How it works

Accounts-payable vendor master record create / find.

Vendors

The Vendors module is the accounts-payable (A/P) vendor master - a first-class reference entity like customers / manufacturers / products. POST /api/Vendors performs a synchronous upsert into the API store keyed by tenant + code (there is no legacy vendor writer yet, so create is a store-only upsert - it does not enqueue a legacy write). Use Find existing to GET /api/Vendors?code=&name= and click a row to load it into the form before editing. The vendor master backs the Pending Charges (billing) module, which resolves its provider payee against these records. Source: legacy A/P vendor master APVE{CID} (key AP_VEND_CODE). Vendors can also be loaded in bulk via POST /api/Import/Entities (the vendors toggle).

Setup

API key + base URL used by every request below.

Credentials

API Key

Base URL

Leave Base URL blank to call this same server with relative paths (the normal case). Set it (e.g. https://asci-api.asciofmiami.com) to point the forms at another host. Every request below sends the ApiKey header.

Idempotency Key

Sent on every create / submit POST. Click Generate for a fresh one, or a new one is auto-generated per submit if blank.

Test form

Interactive form - POSTs to the API and shows the JSON response + HTTP status.

Create an A/P vendor master record: POST /api/Vendors (idempotent store upsert, keyed by tenant + code). Scope: ipjson.submit. The code is client-supplied (it is the legacy AP_VEND_CODE).

Find existing

GETs /api/Vendors?code=&name=. Click a row to load it into the form.

Create

Code (required)

Name

Vendor Type

Contact

Address 1

Address 2

Address 3

City

State

ZIP

Country

Overseas

Phone Area

Phone

Fax Area

Fax

Terms Code

Form Code

GL Acct (A/P)

GL Acct (Expense)

Our Acct No

Recipient ID (1099)

Pay-To Name

Pay-To Address 1

Pay-To Address 2

Pay-To City

Pay-To State

Pay-To ZIP

Pay-To Country

Pay-To Attn

Pay-To Phone

Endpoints

Vendors endpoint family (api/Vendors). Full request schema below.

Vendors endpoints

Method	Path	Scope	Purpose
POST	`/api/Vendors`	`ipjson.submit`	Create / upsert a vendor (body keyed by `code`). Returns `{ code, inserted, updated }`.
GET	`/api/Vendors`	`queue.read`	Search (`?q=` or `?code=&name=&limit=`). Returns `{count, rows}`.
GET	`/api/Vendors/{code}`	`queue.read`	Fetch one vendor by exact code. `404` if absent.
DELETE	`/api/Vendors/{code}`	`ipjson.submit`	Delete one vendor by code. Returns `{ deleted: 1 }`.
DELETE	`/api/Vendors?confirm=true`	`ipjson.submit`	Delete ALL vendors for this tenant (guarded by `?confirm=true`). Returns `{ deleted: <count> }`.

Bulk import. Vendors are also part of the bulk master-data pipeline. Include a vendors toggle + vendors[] array in POST /api/Import/Entities, and the push-to-legacy export GET /api/Import/EntitiesExport?types=vendors emits the #section:vendors TSV block.

Schema

Request body for POST /api/Vendors. The same object is returned by the GET endpoints; GET /api/Vendors wraps the rows as { "count": n, "rows": [ … ] } (each row also carries created_at / updated_at).

Vendor record

Field	Type	Req?	Max	Description
`code`	string	Yes	15	Vendor code / `AP_VEND_CODE`. Primary key (per tenant).
`name`	string	No	-	Vendor name.
`vendor_type`	string	No	-	Vendor type (`AP_VENDOR_TYPE`).
`contact`	string	No	-	Contact name (`AP_CONTACT`).
`address_1` / `address_2` / `address_3`	string	No	-	Address lines.
`city` / `state` / `zip` / `country`	string	No	-	City, state, postal code, country.
`overseas`	string	No	-	Overseas flag.
`phone_area` / `phone`	string	No	-	Phone area code + number.
`fax_area` / `fax`	string	No	-	Fax area code + number.
`terms_code`	string	No	-	Payment-terms code.
`form_code`	string	No	-	Form code.
`gl_acct_ap`	string	No	-	A/P GL control account (`GL_ACCT_AP`).
`gl_acct_no`	string	No	-	Default expense GL account (`GL_ACCT_NO`).
`our_acct_no`	string	No	-	Our account number with this vendor (`OUR_ACCT_NO`).
`recipient_id`	string	No	-	1099 recipient id (`RECIPIENT_ID`).
`payto_name`	string	No	-	Remit-to (pay-to) name.
`payto_addr_1` / `payto_addr_2`	string	No	-	Pay-to address lines.
`payto_city` / `payto_state` / `payto_zip` / `payto_country`	string	No	-	Pay-to city, state, ZIP, country.
`payto_attn`	string	No	-	Pay-to attention line.
`payto_phone`	string	No	-	Pay-to phone.