Supplier

Endpoints

Create new supplier

/companies/{companycode}/suppliers

Description

Returns created supplier.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

Supplier

Responses

HTTP Code Description Schema

201

Successfully created

Supplier

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/suppliers

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

< Supplier > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/suppliers/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportSupplierList

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 supplier

/companies/{companycode}/suppliers/{code}

operation.deprecated

Description

Returns retrieved supplier.

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

Supplier

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete supplier

/companies/{companycode}/suppliers/{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

Supplier

Supplier data structure.

Name Description Value Business Rules

code
required

Supplier code

string

10 characters max

companyCode
required

Current company code

string

2 characters max

hierarchies
optional

Hierarchies

GroupLink list

label
required

Supplier label

string

50 characters max

publicUuid
optional
read-only

Supplier public uuid

string

validityEndDate
optional

Validity end date

datetime

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

ImportSupplierList

Name Value

callback
optional

string

data
optional

Supplier list