ASCI API - Customers

Customers 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

Customer master record create / find.

Customers

The Customers module is a find-or-create write-through master: POST /api/Customers performs a synchronous upsert into the API store and enqueues a legacy CU write. The 6-char code is client-supplied (broker codes are meaningful). Use Find existing to GET /api/Customers?code=&name= and click a row to load it into the form before editing.

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 a customer master record: POST /api/Customers (find-or-create write-through: sync upsert to the API store + enqueue legacy CU write). The 6-char code is client-supplied (broker codes are meaningful).

Find existing

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

Create

Code (required)

ID Qualifier

ID Number (IOR)

Name

Address 1

Address 2

City

State

ZIP

Country

IRS Number

Surety

Bond Type

Continuous Bond Number

Default Manufacturer ID

Endpoints

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

Customers endpoints

Method	Path	Purpose
POST	`/api/Customers`	Create / upsert a customer (body keyed by `code`).
GET	`/api/Customers`	Search (`?q=` or `?code=&name=`). Returns `{count, rows}`.
GET	`/api/Customers/{code}`	Fetch one customer by code.
DELETE	`/api/Customers/{code}`	Delete a customer.

Schema

Request body for POST /api/Customers (customer profile). The same object is returned by the GET endpoints; GET /api/Customers wraps the rows as { "count": n, "rows": [ … ] }.

Customer profile

Field	Type	Req?	Max	Description
`code`	string	Yes	10	Customer / importer code. Primary key (per tenant).
`id_qualifier`	string	No	2	Importer ID qualifier (e.g. EI / SS / CN).
`id_number`	string	No	15	Importer ID number (IRS/EIN/SSN/CBP-assigned).
`name`	string	No	35	Customer name.
`city`	string	No	20	City.
`state`	string	No	2	State / province.
`zip`	string	No	10	Postal code.
`irs_no`	string	No	15	IRS number.
`surety`	string	No	35	Surety company.
`bond_type`	string	No	2	Bond type.
`continuous_bond_no`	string	No	15	Continuous bond number.
`manufacturer_no`	string	No	15	Linked manufacturer / MID number.
`address_1`	string	No	35	Address line 1.
`address_2`	string	No	35	Address line 2.
`country`	string	No	2	Country (ISO 2-char).
`defaults`	object	No	-	Opaque JSON of per-customer ISF default overrides; stored verbatim, not interpreted.