Customer

Endpoints

Create new customer

/companies/{companycode}/customers

Description

Returns created customer.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

Customer

Responses

HTTP Code Description Schema

201

Successfully created

Customer

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/customers

Description

Returns entities.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< Customer > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/customers/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportCustomerList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get one customer

/companies/{companycode}/customers/{code}

operation.deprecated

Description

Returns retrieved customer.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

10 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Responses

HTTP Code Description Schema

200

Successful

Customer

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete customer

/companies/{companycode}/customers/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

10 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Customer

Customer data structure.

Name Description Value Business Rules

code
required

Customer code

string

10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

companyCode
required

Current company code

string

2 characters max

deliveredTo
optional

Delivered to

string

10 characters max

hierarchies
optional

Hierarchies

GroupLink list

label
required

Customer label

string

50 characters max

nature
optional

Nature

string

IN(CUS=Customer,PRO=Prospect,OOC=Other customer,DVT=Delivered to,CES=Transfer)

publicUuid
optional
read-only

Customer public uuid

string

referenceDate
optional

Reference date

string

IN(ORD=Order date, SHI=Expedition date,DEL=Delivery date)

validityEndDate
optional

Validity end date

datetime

YYYY-MM-DDTHH:MM:SSZ
Set a passed date to make the entity inactive.

ImportCustomerList

Name Value

callback
optional

string

data
optional

Customer list