Get customer
curl --request GET \
--url https://api.noyax.com/api/v1/customers/{customerId} \
--header 'Authorization: Bearer <token>' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'GET',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers/{customerId}"
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerCode": "0000382026",
"Name": "Örnek Ticaret A.Ş.",
"TaxNumber": "1234567890",
"TaxOffice": "Kadıköy",
"InvoiceTitle": "Örnek Ticaret Anonim Şirketi",
"Note": "Deliveries on weekdays only.",
"DueDays": 30,
"DiscountRate": 5,
"Blacklisted": false,
"MovementType": 2,
"RiskLimit": 250000,
"RiskControl": 1,
"RiskAction": 1,
"EInvoiceUser": true,
"EInvoiceScenario": 1,
"ShipmentDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"SharingCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ShowNoteOnQuote": false,
"ShowNoteOnOrder": false,
"ShowNoteOnWaybill": true,
"ShowNoteOnInvoice": false,
"IdentitySchemes": [
{
"SchemeID": "MERSISNO",
"Value": "0123456789000015"
}
],
"CreateDate": "2023-11-07T05:31:56Z",
"ModifyDate": "2023-11-07T05:31:56Z",
"Addresses": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictName": "Kadıköy",
"CityName": "İstanbul",
"CountryName": "Türkiye",
"Address": "Caferağa Mah. Moda Cad. No: 10",
"FullAddress": "<string>",
"PostalCode": "34710",
"IsInvoiceAddress": true,
"CoordinateX": 40.9877,
"CoordinateY": 29.0254
}
],
"Telephones": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Number": "02165550000",
"NumberType": 1,
"Extension": "101",
"Description": "Accounting"
}
],
"Links": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Value": "[email protected]",
"LinkType": 1,
"Description": "Invoices"
}
],
"Representatives": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"FullName": "Ayşe Yılmaz",
"Position": "Purchasing Manager",
"Gsm": "05325550000",
"Email": "[email protected]",
"Phone": "02165550000",
"Extension": "105",
"Link": "https://www.linkedin.com/in/example",
"Description": "<string>"
}
],
"BankAccounts": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CurrencyName": "TL",
"BankName": "Example Bank",
"Branch": "Kadıköy",
"AccountNumber": "12345678",
"Iban": "TR330006100519786457841326",
"CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Description": "<string>"
}
],
"GroupMembers": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupDetailName": "Marmara",
"GroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupName": "Region"
}
],
"Parameters": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ParameterDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ParameterName": "Segment",
"ParameterType": 0,
"Value": "Priority"
}
],
"EInvoiceLabels": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Label": "urn:mail:[email protected]",
"Description": "ÖRNEK TİCARET A.Ş.",
"Type": 0,
"IsDefault": true
}
]
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0201",
"Message": "X-UserID header is required.",
"Errors": [
{
"Code": "0201",
"Message": "X-UserID header is required."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "1000",
"Message": "Customer not found.",
"Errors": [
{
"Code": "1000",
"Message": "Customer not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Customer endpoints
Get customer
Returns a customer with all sub-records.
GET
/
api
/
v1
/
customers
/
{customerId}
Get customer
curl --request GET \
--url https://api.noyax.com/api/v1/customers/{customerId} \
--header 'Authorization: Bearer <token>' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'GET',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers/{customerId}"
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerCode": "0000382026",
"Name": "Örnek Ticaret A.Ş.",
"TaxNumber": "1234567890",
"TaxOffice": "Kadıköy",
"InvoiceTitle": "Örnek Ticaret Anonim Şirketi",
"Note": "Deliveries on weekdays only.",
"DueDays": 30,
"DiscountRate": 5,
"Blacklisted": false,
"MovementType": 2,
"RiskLimit": 250000,
"RiskControl": 1,
"RiskAction": 1,
"EInvoiceUser": true,
"EInvoiceScenario": 1,
"ShipmentDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"SharingCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ShowNoteOnQuote": false,
"ShowNoteOnOrder": false,
"ShowNoteOnWaybill": true,
"ShowNoteOnInvoice": false,
"IdentitySchemes": [
{
"SchemeID": "MERSISNO",
"Value": "0123456789000015"
}
],
"CreateDate": "2023-11-07T05:31:56Z",
"ModifyDate": "2023-11-07T05:31:56Z",
"Addresses": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"DistrictName": "Kadıköy",
"CityName": "İstanbul",
"CountryName": "Türkiye",
"Address": "Caferağa Mah. Moda Cad. No: 10",
"FullAddress": "<string>",
"PostalCode": "34710",
"IsInvoiceAddress": true,
"CoordinateX": 40.9877,
"CoordinateY": 29.0254
}
],
"Telephones": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Number": "02165550000",
"NumberType": 1,
"Extension": "101",
"Description": "Accounting"
}
],
"Links": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Value": "[email protected]",
"LinkType": 1,
"Description": "Invoices"
}
],
"Representatives": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"FullName": "Ayşe Yılmaz",
"Position": "Purchasing Manager",
"Gsm": "05325550000",
"Email": "[email protected]",
"Phone": "02165550000",
"Extension": "105",
"Link": "https://www.linkedin.com/in/example",
"Description": "<string>"
}
],
"BankAccounts": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CurrencyName": "TL",
"BankName": "Example Bank",
"Branch": "Kadıköy",
"AccountNumber": "12345678",
"Iban": "TR330006100519786457841326",
"CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Description": "<string>"
}
],
"GroupMembers": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupDetailName": "Marmara",
"GroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupName": "Region"
}
],
"Parameters": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ParameterDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ParameterName": "Segment",
"ParameterType": 0,
"Value": "Priority"
}
],
"EInvoiceLabels": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Label": "urn:mail:[email protected]",
"Description": "ÖRNEK TİCARET A.Ş.",
"Type": 0,
"IsDefault": true
}
]
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0201",
"Message": "X-UserID header is required.",
"Errors": [
{
"Code": "0201",
"Message": "X-UserID header is required."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "1000",
"Message": "Customer not found.",
"Errors": [
{
"Code": "1000",
"Message": "Customer not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Customer visibility depends on the sharing code. A customer the user cannot see returns 404. See Sharing codes.
Authorizations
Access token obtained from the Noyax auth service with your API key.
Headers
ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.
Required range:
x >= 1ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.
Required range:
x >= 1ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.
Required range:
x >= 1Path Parameters
Customer ID.
Response
OK
Whether the operation succeeded.
Example:
true
"0000" on success. On failure, the code of the first error; all errors are listed in Errors.
Example:
"0000"
Response data. Null when Success is false.
Show child attributes
Show child attributes
Error message when Success is false. Messages of all errors are joined into a single text.