API - Customers
This is a fork of page 30009 "APIV2 - Customers" from version 23.3.14876.15704. Added support for Extra Fields and Extra Values.
Object Definition
| Object Type | Page |
| Object ID | 70314139 |
| Object Name | QWESR API - Customers |
| Source Table | Customer |
API Definition
| APIPublisher | smartApps |
| APIGroup | spider |
| APIVersion | v1.0 |
| EntitySetName | customers |
| EntityName | customer |
Events
| Name | Description |
|---|---|
| OnAfterInsert(Record Customer; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text; List of [Integer]) | Raised after a record is inserted. A Modify of the Customer record will be called after this event. |
| OnBeforeModify(Record Customer; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text; List of [Integer]) | Raised before a record is modified. |
| OnGetExtraValues(Record Customer; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text) | Raised after a record is read from the database. Makes it possible to set the ExtraValues 1..10, to be returned to the client. |
Example
Read
Get a list of Customers.
GET businesscentralPrefix/companies({id})/customers?$schemaversion=2.0
Get a single Customer.
GET businesscentralPrefix/companies({id})/customers({id})?$schemaversion=2.0
Create
Create a new Customer.
POST businesscentralPrefix/companies({id})/customers?$schemaversion=2.0
Content-type: application/json
{
"displayName": "Cronus"
}
Controls
| Type | Name | Data Type | Read-only |
|---|---|---|---|
| Field | id | Guid | Yes |
| Field | number | Code[20] | |
| Field | displayName | Text[100] | |
| Field | type | Enum "Contact Type" | |
| Field | addressLine1 | Text[100] | |
| Field | addressLine2 | Text[50] | |
| Field | city | Text[30] | |
| Field | state | Text[30] | |
| Field | country | Code[10] | |
| Field | postalCode | Code[20] | |
| Field | phoneNumber | Text[30] | |
| Field | Text[80] | ||
| Field | website | Text[255] | |
| Field | salespersonCode | Code[20] | |
| Field | balanceDue | Decimal | Yes |
| Field | creditLimit | Decimal | |
| Field | taxLiable | Boolean | |
| Field | taxAreaId | Guid | |
| Field | taxAreaDisplayName | Text | Yes |
| Field | taxRegistrationNumber | Text[50] | |
| Field | currencyId | Guid | |
| Field | currencyCode | Text | |
| Field | paymentTermsId | Guid | |
| Field | shipmentMethodId | Guid | |
| Field | paymentMethodId | Guid | |
| Field | blocked | Enum "Customer Blocked" | |
| Field | lastModifiedDateTime | DateTime | Yes |
| Field | extraCode1 | Code[20] | |
| Field | extraCode2 | Code[20] | |
| Field | extraCode3 | Code[20] | |
| Field | extraCode4 | Code[20] | |
| Field | extraCode5 | Code[20] | |
| Field | extraCode6 | Code[20] | |
| Field | extraCode7 | Code[20] | |
| Field | extraCode8 | Code[20] | |
| Field | extraText1 | Text[50] | |
| Field | extraText2 | Text[50] | |
| Field | extraText3 | Text[50] | |
| Field | extraText4 | Text[50] | |
| Field | extraDecimal1 | Decimal | |
| Field | extraDecimal2 | Decimal | |
| Field | extraDecimal3 | Decimal | |
| Field | extraDecimal4 | Decimal | |
| Field | extraInteger1 | Integer | |
| Field | extraInteger2 | Integer | |
| Field | extraInteger3 | Integer | |
| Field | extraInteger4 | Integer | |
| Field | extraDate1 | Date | |
| Field | extraDate2 | Date | |
| Field | extraDate3 | Date | |
| Field | extraDate4 | Date | |
| Field | extraBoolean1 | Boolean | |
| Field | extraBoolean2 | Boolean | |
| Field | extraBoolean3 | Boolean | |
| Field | extraBoolean4 | Boolean | |
| Field | extraValue1 | Text | |
| Field | extraValue2 | Text | |
| Field | extraValue3 | Text | |
| Field | extraValue4 | Text | |
| Field | extraValue5 | Text | |
| Field | extraValue6 | Text | |
| Field | extraValue7 | Text | |
| Field | extraValue8 | Text | |
| Field | extraValue9 | Text | |
| Field | extraValue10 | Text | |
| Sub page | customerFinancialDetails | Yes | |
| Sub page | picture | ||
| Sub page | defaultDimensions | ||
| Sub page | agedAccountsReceivable | Yes | |
| Sub page | contactsInformation | Yes | |
| Sub page | documentAttachments |
This documentation is generated from Spider v27.0