Leveranciers

Leveranciers

Leveranciers ophalen. Zelfde veldnamen als klant-lijstitems. Scope: relations.read.

Leveranciers ophalen

GET /v1/suppliers
clients.read
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
Naam Type Beschrijving
page integer Paginanummer (vanaf 1, default 1)
per_page integer Items per pagina (default 25, max 200)
search string Zoeken
contact_type string Filter op contacttype
Request body

Geen

Response
data object[]
guid string
Example: b2c3d4e5-f6a7-8901-bcde-f12345678901
type string
Enum
company private
Example: company
company_name string
Example: Voorbeeld BV
firstname string Nullable
Example: null
lastname string Nullable
Example: null
email string
phone string
Example: +31612345678
city string
Example: Amsterdam
country string
Example: NL
debtor_number string
Example: D-1001
meta object
page integer
Example: 1
per_page integer
Example: 25
total integer
Example: 1
pages integer
Example: 1

Examples

GET /v1/suppliers
curl -X GET "https://api.appficient.nl/v1/suppliers" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Leverancier aanmaken

POST /v1/suppliers
clients.write
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Headers
Naam Type Beschrijving
Idempotency-Key string Optional on POST only; cached 24h; replay returns X-Idempotent-Replay
Request body
type string

Relation type. On write, only exact `company` stays company; any other value becomes `private`.

Enum
company private
company_name string
firstname string
lastname string
email string
phone string
city string
country string
Response
data object Required

UUID `id` only; no internal integer PKs in response.

id string
type string

Relation type. On write, only exact `company` stays company; any other value becomes `private`.

Enum
company private
company_name string
firstname string
lastname string
email string
phone string
city string
country string
debtor_number string
meta object Required

Examples

POST /v1/suppliers
curl -X POST "https://api.appficient.nl/v1/suppliers" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "company",
    "company_name": "string",
    "firstname": "string",
    "lastname": "string",
    "email": "string",
    "phone": "string",
    "city": "string",
    "country": "string"
}'

Curl, Node en response staan rechts naast dit endpoint.

Leverancier ophalen

GET /v1/suppliers/{id}
clients.read
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string Resource id (UUID, lowercase)
Request body

Geen

Response
data object Required

UUID `id` only; no internal integer PKs in response.

id string
type string

Relation type. On write, only exact `company` stays company; any other value becomes `private`.

Enum
company private
company_name string
firstname string
lastname string
email string
phone string
city string
country string
debtor_number string
meta object Required

Examples

GET /v1/suppliers/{id}
curl -X GET "https://api.appficient.nl/v1/suppliers/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Leverancier bijwerken

PATCH /v1/suppliers/{id}
clients.write

At least one field required

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string Resource id (UUID, lowercase)
Request body
type string

Relation type. On write, only exact `company` stays company; any other value becomes `private`.

Enum
company private
company_name string
firstname string
lastname string
email string
phone string
city string
country string
Response
data object Required

UUID `id` only; no internal integer PKs in response.

id string
type string

Relation type. On write, only exact `company` stays company; any other value becomes `private`.

Enum
company private
company_name string
firstname string
lastname string
email string
phone string
city string
country string
debtor_number string
meta object Required

Examples

PATCH /v1/suppliers/{id}
curl -X PATCH "https://api.appficient.nl/v1/suppliers/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "company",
    "company_name": "string",
    "firstname": "string",
    "lastname": "string",
    "email": "string",
    "phone": "string",
    "city": "string",
    "country": "string"
}'

Curl, Node en response staan rechts naast dit endpoint.