Suppliers

Suppliers represent a supplier in the system. They contain information about the supplier, such as their name, address, and contact details but also their prices, services, activities and files.

The Supplier object

Properties

idstring
Unique identifier for the object.
namestring
The name of the supplier.
addressobject
Address
archivedboolean
True if the entity is archived.
catConfigurationobject
The default CAT configuration for the supplier.
contactsarray
Contacts (only applicable if supplierType is company)
dedicatedClientsarray
The list of dedicated clients for the supplier.
detailsstring
Additional details.
domainsarray
The domains of expertise of the supplier.
emailstring
The email address.
filenameFormatsobject
Filename format settings
filesarray
The files.
labelsarray
The labels.
languagePairsarray
The languages pairs
logoUrlstring
The logo Url.
marketingsarray
The marketing notes
mobilePhonestring
The mobile phone number (only applicable if supplierType is freelancer).
nationalIdentificationNumberstring
The national identification number, if applicable (SIRET, KVK, etc).
nicknamestring
The nickname of the supplier (only applicable if supplierType is freelancer).
notesarray
The notes linked to the entity.
phonestring
The phone number (only applicable if supplierType is freelancer).
pinnedboolean
True if the entity is pinned.
purchaseOrderobject
Purchase order options.
ratingnumber
The rating of the supplier.
servicesarray
The services.
supplierTypestring
One of the following value: freelance, company.
timezonestring
timezone
unavailabilitiesarray
Unavailabilities
vatNumberstring
The VAT number of the company.
createdAtdate
The date and time the entity was created.
updatedAtdate
The date and time the entity was last updated.

Supplier object

{
  "id": "659bfadde9bb5bd797708d69",
  "name": "Arnaud Bachelier",
  "address": {
    "name": "Arnaud Bachelier"
  },
  "archived": false,
  "contacts": [],
  "dedicatedClients": [],
  "domains": [
    {
      "id": "659bf8f25959fed584cd38db",
      "name": "IT"
    }
  ],
  "email": "arnaudbachelier@gmail.com",
  "files": [],
  "labels": [
    {
      "id": "659bf8f25959fed584cd38c9",
      "name": "IT",
      "color": "#15803D"
    }
  ],
  "languagePairs": [
    {
      "source": {
        "code": "en",
        "name": "English"
      },
      "target": {
        "code": "fr",
        "name": "French"
      },
      "id": "659bf8f35959fed584cd38e1",
      "bidirectional": false
    }
  ],
  "marketings": [],
  "notes": [],
  "pinned": false,
  "purchaseOrder": {
    "applyVATReverseCharge": false,
    "currency": {
      "code": "EUR",
      "symbol": "€"
    },
    "document": {
      "id": "6548c11c5136b418fd626e59",
      "name": "Français"
    },
    "minimumFee": 30,
    "paymentTerms": 30,
    "paymentTermsEndOfMonth": false,
    "rappenRounding": false,
    "tax1": {
      "id": "6548c1705136b418fd626e65",
      "name": "VAT",
      "value": 0.21
    }
  },
  "services": [
    {
      "service": {
        "id": "6548c16d5136b418fd626e5f",
        "name": "Translation"
      },
      "languagePair": {
        "source": {
          "code": "en",
          "name": "English"
        },
        "target": {
          "code": "fr",
          "name": "French"
        },
        "id": "659bf8f35959fed584cd38e1",
        "bidirectional": false
      },
      "quantityType": {
        "id": "6548c16d5136b418fd626e61",
        "name": "Words"
      },
      "currency": {
        "code": "EUR",
        "symbol": "€"
      },
      "unitCost": 0.08,
      "matchesType": "fixed",
      "hasPrice": true,
      "matches": [],
      "id": "659bfadde9bb5bd797708d73"
    }
  ],
  "supplierType": "freelance",
  "timezone": "Europe/Brussels",
  "unavailabilities": [],
  "createdAt": "2024-01-08T13:38:37.009Z",
  "updatedAt": "2024-06-13T07:14:28.050Z"
}

GET/v2/suppliers

List all Suppliers

This endpoint allows you to retrieve all the suppliers.

Filters

All the filters are optional and can be combined. See Pagination for the rules shared by all the list endpoints (multiple values, dates, keywords).

namestring
Only the suppliers whose name contains this text (not case sensitive).
emailstring
Only the suppliers whose email contains this text (not case sensitive).
services.service.idstring
Comma-separated list of service ids. Only the suppliers that have one of these services are returned.
services.quantityType.idstring
Comma-separated list of unit ids. Only the suppliers that have a service in one of these units are returned.
services.domain.idstring
Comma-separated list of domain of expertise ids. Only the suppliers that have a service for one of these domains of expertise are returned.
dedicatedClient.idstring
Comma-separated list of client ids. Only the suppliers dedicated to one of these clients are returned.
domains.idstring
Comma-separated list of domain of expertise ids. Only the suppliers that have at least one of these domains of expertise are returned (see domains.all).
domains.allboolean
Set to true to return only the suppliers that have all the domains of expertise of domains.id.
languagePairs.idstring
Comma-separated list of language pair ids. Only the suppliers that have one of these language pairs are returned.
labels.idstring
Comma-separated list of label ids. The suppliers that have at least one of these labels are returned (see labels.all).
labels.allboolean
Set to true to return only the suppliers that have all the labels of labels.id.
archivedboolean
true to retrieve only the archived suppliers, false to exclude them. If not provided, both are returned.

Sorting

sortstring
The field to sort by. One of: name, rating. The default is name.
directionstring
The sort direction: asc or desc. The default is asc.

Request

GET

/v2/suppliers

curl -G https://api.lsp.expert/v2/suppliers \
  -u {key}:

Response

{
  "items": [{
    "id": "659bfadde9bb5bd797708d69",
    "name": "Arnaud Bachelier",
    "address": {
      "name": "Arnaud Bachelier"
    },
    "archived": false,
    "contacts": [],
    "dedicatedClients": [],
    "domains": [],
    "email": "arnaudbachelier@gmail.com",
    "files": [],
    "labels": [],
    "languagePairs": [
      {
        "source": {
          "code": "en",
          "name": "English"
        },
        "target": {
          "code": "fr",
          "name": "French"
        },
        "id": "659bf8f35959fed584cd38e1",
        "bidirectional": false
      }
    ],
    "marketings": [],
    "notes": [],
    "pinned": false,
    "purchaseOrder": {
      "applyVATReverseCharge": false,
      "currency": {
        "code": "EUR",
        "symbol": "€"
      },
      "document": {
        "id": "6548c11c5136b418fd626e59",
        "name": "Français"
      },
      "minimumFee": 30,
      "paymentTerms": 30,
      "paymentTermsEndOfMonth": false,
      "rappenRounding": false,
      "tax1": {
        "id": "6548c1705136b418fd626e65",
        "name": "VAT",
        "value": 0.21
      }
    },
    "services": [
      {
        "service": {
          "id": "6548c16d5136b418fd626e5f",
          "name": "Translation"
        },
        "languagePair": {
          "source": {
            "code": "en",
            "name": "English"
          },
          "target": {
            "code": "fr",
            "name": "French"
          },
          "id": "659bf8f35959fed584cd38e1",
          "bidirectional": false
        },
        "quantityType": {
          "id": "6548c16d5136b418fd626e61",
          "name": "Words"
        },
        "currency": {
          "code": "EUR",
          "symbol": "€"
        },
        "unitCost": 0.08,
        "matchesType": "fixed",
        "hasPrice": true,
        "matches": [],
        "id": "659bfadde9bb5bd797708d73"
      }
    ],
    "supplierType": "freelance",
    "timezone": "Europe/Brussels",
    "unavailabilities": [],
    "createdAt": "2024-01-08T13:38:37.009Z",
    "updatedAt": "2024-06-13T07:14:28.050Z"
  },
  {...},
  {...}
],
  "pageSize": 20,
  "page": 1,
  "totalPages": 1,
  "totalItems": 2,
  "hasNextPage": false,
  "hasPreviousPage": false
}

POST/v2/suppliers

Create a supplier

This endpoint allows you to add a new supplier.

Parameters

namestring Required
The name of the supplier.
addressCitystring,null
City, district, suburb, town, or village.
addressCountrystring,null
Two-letter country code.
addressLine1string,null
Address line 1 (e.g., street, PO Box, or company name).
addressLine2string,null
Address line 2 (e.g., apartment, suite, unit, or building).
addressNamestring,null
Business name.
addressPostalCodestring,null
ZIP or postal code.
addressStatestring,null
State, county, province, or region.
applyVATReverseChargeboolean
True if the reverse charge applies.
catConfigurationstring
The default CAT configuration id.
currencystring
The currency code (ISO, e.g., EUR).
detailsstring,null
The additional details.
documentstring
The document id.
emailstring
The email address (only applicable if supplierType is freelancer).
minimumFeenumber,null
The minimum fee to be applied.
mobilePhonestring,null
The mobile phone number (only applicable if supplierType is freelancer).
nationalIdentificationNumberstring,null
The national identification number, if applicable (SIRET, KVK, etc).
nicknamestring,null
The nickname of the supplier (only applicable if supplierType is freelancer).
paymentTermsnumber,null
The payment terms in days.
paymentTermsEndOfMonthboolean,null
True if the payment terms are at the end of the month.
phonestring,null
The phone number (only applicable if supplierType is freelancer).
purchaseOrderFilenameFormatstring
The filename format for the purchase orders.
rappenRoundingboolean
True if the rounding should be done in rappen (Swiss Francs only).
supplierTypestring
One of the following value: freelance, company.
tax1string,null
The id of the tax1.
tax2string,null
The id of the tax2.
timezonestring,null
The timezone (e.g., Europe/Brussels).
vatNumberstring,null
The VAT number of the company.

Request

POST

/v2/suppliers

curl https://api.lsp.expert/v2/suppliers \
  -u {key}: \
  -d name="John Smith"

Response

{
  "id": "66fa558df6433d59fb991355",
  "name": "John Smith",
  "address": {
    "name": "John Smith"
  },
  "archived": false,
  "contacts": [],
  "dedicatedClients": [],
  "domains": [],
  "files": [],
  "labels": [],
  "languagePairs": [],
  "marketings": [],
  "nickname": "John",
  "notes": [],
  "object": "supplier",
  "pinned": false,
  "purchaseOrder": {
    "applyVATReverseCharge": false,
    "currency": {
      "code": "EUR",
      "symbol": "€"
    },
    "document": {
      "id": "6548c11c5136b418fd626e58",
      "name": "English"
    },
    "minimumFee": 0,
    "paymentTermsEndOfMonth": false,
    "rappenRounding": false,
    "tax1": {
      "id": "6548c1705136b418fd626e65",
      "name": "VAT",
      "value": 0.21
    }
  },
  "services": [],
  "supplierType": "freelance",
  "unavailabilities": [],
  "createdAt": "2024-09-30T07:38:53.330Z",
  "updatedAt": "2024-09-30T07:38:53.342Z"
}

GET/v2/suppliers/:id

Retrieve a supplier

This endpoint allows you to retrieve a supplier by providing their id.

Request

GET

/v2/suppliers/:id

curl https://api.lsp.expert/v2/suppliers/66fa558df6433d59fb991355 \
  -u {key}:

Response

{
  "id": "66fa558df6433d59fb991355",
  "name": "John Smith",
  "address": {
    "name": "John Smith"
  },
  "archived": false,
  "contacts": [],
  "dedicatedClients": [],
  "domains": [],
  "files": [],
  "labels": [],
  "languagePairs": [],
  "marketings": [],
  "nickname": "John",
  "notes": [],
  "object": "supplier",
  "pinned": false,
  "purchaseOrder": {
    "applyVATReverseCharge": false,
    "currency": {
      "code": "EUR",
      "symbol": "€"
    },
    "document": {
      "id": "6548c11c5136b418fd626e58",
      "name": "English"
    },
    "minimumFee": 0,
    "paymentTermsEndOfMonth": false,
    "rappenRounding": false,
    "tax1": {
      "id": "6548c1705136b418fd626e65",
      "name": "VAT",
      "value": 0.21
    }
  },
  "services": [],
  "supplierType": "freelance",
  "unavailabilities": [],
  "createdAt": "2024-09-30T07:38:53.330Z",
  "updatedAt": "2024-09-30T07:38:53.342Z"
}

PUT/v2/suppliers/:id

Update a supplier

This endpoint allows you to perform an update on a supplier. Any parameters not provided will be left unchanged.

Parameters

namestring
The name of the supplier.
addressCitystring,null
City, district, suburb, town, or village.
addressCountrystring,null
Two-letter country code.
addressLine1string,null
Address line 1 (e.g., street, PO Box, or company name).
addressLine2string,null
Address line 2 (e.g., apartment, suite, unit, or building).
addressNamestring,null
Business name.
addressPostalCodestring,null
ZIP or postal code.
addressStatestring,null
State, county, province, or region.
applyVATReverseChargeboolean
True if the reverse charge applies.
archivedboolean
True if the entity is archived.
catConfigurationstring,null
The default CAT configuration id.
currencystring
The currency code (ISO, e.g., EUR).
detailsstring,null
The additional details.
documentstring
The document id.
emailundefined
The email address (only applicable if supplierType is freelancer).
minimumFeenumber,null
The minimum fee to be applied.
mobilePhonestring,null
The mobile phone number (only applicable if supplierType is freelancer).
nationalIdentificationNumberstring,null
The national identification number, if applicable (SIRET, KVK, etc).
nicknamestring,null
The nickname of the supplier (only applicable if supplierType is freelancer).
paymentTermsnumber,null
The payment terms in days.
paymentTermsEndOfMonthboolean,null
True if the payment terms are at the end of the month.
phonestring,null
The phone number (only applicable if supplierType is freelancer).
pinnedboolean
True if the entity is pinned.
purchaseOrderFilenameFormatstring,null
The filename format for the purchase orders.
rappenRoundingboolean
True if the rounding should be done in rappen (Swiss Francs only).
supplierTypestring
One of the following value: freelance, company.
tax1string,null
The id of the tax1.
tax2string,null
The id of the tax2.
timezonestring,null
The timezone (e.g., Europe/Brussels).
vatNumberstring,null
The VAT number of the company.

Request

PUT

/v2/suppliers/:id

curl -X PUT https://api.lsp.expert/v2/suppliers/66fa558df6433d59fb991355 \
  -u {key}: \
  -d email="john@smith.com"

Response

{
  "id": "66fa558df6433d59fb991355",
  "name": "John Smith",
  "address": {
    "name": "John Smith"
  },
  "archived": false,
  "contacts": [],
  "dedicatedClients": [],
  "domains": [],
  "email": "john@smith.com",
  "files": [],
  "labels": [],
  "languagePairs": [],
  "marketings": [],
  "nickname": "John",
  "notes": [],
  "object": "supplier",
  "pinned": false,
  "purchaseOrder": {
    "applyVATReverseCharge": false,
    "currency": {
      "code": "EUR",
      "symbol": "€"
    },
    "document": {
      "id": "6548c11c5136b418fd626e58",
      "name": "English"
    },
    "minimumFee": 0,
    "paymentTermsEndOfMonth": false,
    "rappenRounding": false,
    "tax1": {
      "id": "6548c1705136b418fd626e65",
      "name": "VAT",
      "value": 0.21
    }
  },
  "services": [],
  "supplierType": "freelance",
  "unavailabilities": [],
  "createdAt": "2024-09-30T07:38:53.330Z",
  "updatedAt": "2024-09-30T07:38:53.342Z"
}

DELETE/v2/suppliers/:id

Delete a supplier

This endpoint allows you to delete a supplier.

Request

DELETE

/v2/suppliers/:id

curl -X DELETE https://api.lsp.expert/v2/suppliers/66fa558df6433d59fb991355 \
  -u {key}:

Suppliers

The Supplier object

Properties

idstring

namestring

addressobject

archivedboolean

catConfigurationobject

contactsarray

dedicatedClientsarray

detailsstring

domainsarray

emailstring

filenameFormatsobject

filesarray

labelsarray

languagePairsarray

logoUrlstring

marketingsarray

mobilePhonestring

nationalIdentificationNumberstring

nicknamestring

notesarray

phonestring

pinnedboolean

purchaseOrderobject

ratingnumber

servicesarray

supplierTypestring

timezonestring

unavailabilitiesarray

vatNumberstring

createdAtdate

updatedAtdate

Supplier object

List all Suppliers

Filters

namestring

emailstring

services.service.idstring

services.quantityType.idstring

services.domain.idstring

dedicatedClient.idstring

domains.idstring

domains.allboolean

languagePairs.idstring

labels.idstring

labels.allboolean

archivedboolean

Sorting

sortstring

directionstring

Request

Response

Create a supplier

Parameters

namestring Required

addressCitystring,null

addressCountrystring,null

addressLine1string,null

addressLine2string,null

addressNamestring,null

addressPostalCodestring,null

addressStatestring,null

applyVATReverseChargeboolean

catConfigurationstring

currencystring

detailsstring,null

documentstring

emailstring

minimumFeenumber,null

mobilePhonestring,null

nationalIdentificationNumberstring,null

nicknamestring,null

paymentTermsnumber,null

paymentTermsEndOfMonthboolean,null

phonestring,null

purchaseOrderFilenameFormatstring

rappenRoundingboolean

supplierTypestring