Patch supplier
const options = {
method: 'PATCH',
headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
email: '<string>',
phone: '<string>',
website: '<string>',
taxNumber: '<string>',
registrationNumber: '<string>',
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
isEmpty: true
},
bankDetails: {
accountHolderName: '<string>',
accountNumber: '<string>',
sortCode: '<string>',
routingNumber: '<string>',
iban: '<string>',
bicSwift: '<string>',
country: '<string>',
currency: '<string>'
},
paymentTermsDefault: '<string>'
})
};
fetch('https://api.dolfinai.co/v1/suppliers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dolfinai.co/v1/suppliers/{id}"
payload = {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"taxNumber": "<string>",
"registrationNumber": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"isEmpty": True
},
"bankDetails": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"sortCode": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"bicSwift": "<string>",
"country": "<string>",
"currency": "<string>"
},
"paymentTermsDefault": "<string>"
}
headers = {
"x-dolfin-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.dolfinai.co/v1/suppliers/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"isEmpty\": true\n },\n \"bankDetails\": {\n \"accountHolderName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"routingNumber\": \"<string>\",\n \"iban\": \"<string>\",\n \"bicSwift\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\"\n },\n \"paymentTermsDefault\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request PATCH \
--url https://api.dolfinai.co/v1/suppliers/{id} \
--header 'Content-Type: application/json' \
--header 'x-dolfin-api-key: <api-key>' \
--data '
{
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"taxNumber": "<string>",
"registrationNumber": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"isEmpty": true
},
"bankDetails": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"sortCode": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"bicSwift": "<string>",
"country": "<string>",
"currency": "<string>"
},
"paymentTermsDefault": "<string>"
}
'{
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"taxNumber": "<string>",
"registrationNumber": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"isEmpty": true
},
"bankDetails": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"sortCode": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"bicSwift": "<string>",
"country": "<string>",
"currency": "<string>"
},
"bankDetailsVerified": true,
"bankDetailsVerifiedAt": "2023-11-07T05:31:56Z",
"paymentTermsDefault": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Suppliers
Patch supplier
Partially update a supplier’s details.
Authentication. An API key (x-dolfin-api-key) together with the x-dolfin-organisation-id header identifying the organisation, or a JWT Bearer token that carries the organisation in its claims.
PATCH
/
v1
/
suppliers
/
{id}
Patch supplier
const options = {
method: 'PATCH',
headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
email: '<string>',
phone: '<string>',
website: '<string>',
taxNumber: '<string>',
registrationNumber: '<string>',
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
isEmpty: true
},
bankDetails: {
accountHolderName: '<string>',
accountNumber: '<string>',
sortCode: '<string>',
routingNumber: '<string>',
iban: '<string>',
bicSwift: '<string>',
country: '<string>',
currency: '<string>'
},
paymentTermsDefault: '<string>'
})
};
fetch('https://api.dolfinai.co/v1/suppliers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dolfinai.co/v1/suppliers/{id}"
payload = {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"taxNumber": "<string>",
"registrationNumber": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"isEmpty": True
},
"bankDetails": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"sortCode": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"bicSwift": "<string>",
"country": "<string>",
"currency": "<string>"
},
"paymentTermsDefault": "<string>"
}
headers = {
"x-dolfin-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.dolfinai.co/v1/suppliers/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"isEmpty\": true\n },\n \"bankDetails\": {\n \"accountHolderName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"routingNumber\": \"<string>\",\n \"iban\": \"<string>\",\n \"bicSwift\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\"\n },\n \"paymentTermsDefault\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request PATCH \
--url https://api.dolfinai.co/v1/suppliers/{id} \
--header 'Content-Type: application/json' \
--header 'x-dolfin-api-key: <api-key>' \
--data '
{
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"taxNumber": "<string>",
"registrationNumber": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"isEmpty": true
},
"bankDetails": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"sortCode": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"bicSwift": "<string>",
"country": "<string>",
"currency": "<string>"
},
"paymentTermsDefault": "<string>"
}
'{
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"taxNumber": "<string>",
"registrationNumber": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"isEmpty": true
},
"bankDetails": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"sortCode": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"bicSwift": "<string>",
"country": "<string>",
"currency": "<string>"
},
"bankDetailsVerified": true,
"bankDetailsVerifiedAt": "2023-11-07T05:31:56Z",
"paymentTermsDefault": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
ApiKeyBearer
An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.
Headers
Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).
Path Parameters
Body
application/json
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I