API - Customers | Wisefish Manuals

Overview

The list page that contains the Customers. Similar API does also exist in the standard BC, but since there are some added Wisefish fields a new API was created.

Endpoint name	`customers`
Source table	`Customer`
Fixed view
Requests allowed	GET, POST, PATCH, DELETE
Primary key	“No.”
Record ID	`customerNo`
Procedures

Data

Field List

Property	Type	Format	Description
`systemId`	string	uuid		non-editable
`number`	string	max 20	Field “No.”, the unique id of the customer.	Record ID primary key
`name`	string	max 100		mandatory
`name2`	string	max 50		optional
`addressLine1`	string	max 100		optional
`addressLine2`	string	max 50		optional
`postalCode`	string	max 20		optional
`city`	string	max 30		optional
`state`	string	max 30	Field “County”	optional
`country`	string	max 20		optional
`contact`	string	max 100		optional
`email`	string	max 80		optional
`salespersonCode`	string	max 20		optional
`genBusPostingGroup`	string	max 10		mandatory
`customerPostingGroup`	string	max 20		mandatory
`currencyCode`	string	max 10		optional
`billToCustomerId`	string	uuid		optional
`billToCustomerNo`	string	max 20		optional
`customerPriceGroup`	string	max 10		optional
`blocked`	string	(enum/flag)		optional
`paymentMethodCode`	string	max 10		recommended
`paymentTermsCode`	string	max 10		recommended
`salesType`	string	(enum/flag)	Options: (blank), Export	optional
`placeOfDelivery`	string	max 10		optional
`eulerID`	string	max 10		optional
`addRef`	string	max 30		optional
`paymentBankAccount`	string	max 20		optional
`ediCustomerCode`	string	max 35		optional
`lastModified`	string	date-time		non-editable

Example Object

An example of one object :

JSON

{
    "customerNo": "01121212",
    "systemId": "8ad0189f-dd11-ef11-9f8b-6045bde9cc61",
    "name": "Spotsmeyer's Furnishings",
    "name2": "",
    "addressLine1": "612 South Sunset Drive",
    "addressLine2": "",
    "postalCode": "US-FL 37125",
    "city": "Miami",
    "state": "FL",
    "country": "US",
    "contact": "Mr. Mike Nash",
    "email": "",
    "salespersonCode": "OF",
    "genBusPostingGroup": "EXPORT",
    "customerPostingGroup": "FOREIGN",
    "currencyCode": "USD",
    "billToCustomerId": "9cd0189f-dd11-ef11-9f8b-6045bde9cc61",
    "billToCustomerNo": "01454545",
    "customerPriceGroup": "",
    "blocked": " ",
    "paymentMethodCode": "",
    "paymentTermsCode": "1M(8D)",
    "salesType": " ",
    "placeOfDelivery": "",
    "eulerID": "",
    "addRef": "",
    "paymentBankAccount": "",
    "ediCustomerCode": "",
    "lastModified": "2025-09-24T10:44:09.453Z"
}

Usage

Read all entries

GET
.../customers

Read a specific entry

To read customer number ‘01121212’:

GET
.../customers('01121212')

Insert a Customer

The API allows inserting, modifying and deleting entries. All same error handling applies as when the same is done within Business Central. Note that the fields marked “MANDATORY” in the list above are the fields that must be populated in order to post sales on the customer.

Example:

POST
.../customers

Body:
{
    "customerNo": "007",
    "name": "The Double O Seven Agency",
    "contact": "Mr. James Bond",
    "salespersonCode": "OF",
    "genBusPostingGroup": "EXPORT",
    "customerPostingGroup": "FOREIGN",
    "currencyCode": "USD",
    "paymentTermsCode": "1M(8D)",
}