{ "info": { "_postman_id": "b7b6e6b0-2f5b-4f0a-9f8a-noyaxapi000001", "name": "Noyax API", "description": "Generated from docs/api-reference/openapi.json (see docs/scripts/generate-postman-collection.mjs) - always reflects the real controllers/DTOs, not a hand-maintained copy. Re-run the generator after endpoints change.\n\nQuick start: fill in authBaseUrl/baseUrl/orgName/apiKey/userId/companyId in the collection variables (or import the companion environment file), then run Auth > Login once - it saves the access/refresh token into collection variables automatically, and every other request inherits Bearer auth from the collection.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "variable": [ { "key": "authBaseUrl", "value": "https://dev.noyax.com/services/bb_auth_service", "type": "string" }, { "key": "baseUrl", "value": "https://dev.noyax.com/services/noyax_api", "type": "string" }, { "key": "orgName", "value": "", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" }, { "key": "accessToken", "value": "", "type": "string" }, { "key": "refreshToken", "value": "", "type": "string" }, { "key": "userId", "value": "1", "type": "string" }, { "key": "companyId", "value": "1", "type": "string" }, { "key": "periodId", "value": "", "type": "string" } ], "item": [ { "name": "Auth", "description": "BulutBudurAuthService (separate service, separate base URL). NoyaxApi itself never issues tokens.", "item": [ { "name": "Login", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"OrgName\": \"{{orgName}}\",\n \"ApiKey\": \"{{apiKey}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{authBaseUrl}}/api/ApiAuth/login", "host": [ "{{authBaseUrl}}" ], "path": [ "api", "ApiAuth", "login" ] }, "description": "Exchanges OrgName + ApiKey (from OrgAPIKeys) for an access/refresh token pair. On success, the Tests script below saves both into the collection variables accessToken/refreshToken so every other request (Bearer auth is set at the collection level) picks it up automatically." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "if (body.Success) {", " pm.collectionVariables.set('accessToken', body.Data.AccessToken);", " pm.collectionVariables.set('refreshToken', body.Data.RefreshToken);", " console.log('Saved accessToken/refreshToken to collection variables.');", "} else {", " console.warn('Login failed:', body.Message);", "}" ] } } ] }, { "name": "Refresh token", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"AccessToken\": \"{{accessToken}}\",\n \"RefreshToken\": \"{{refreshToken}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{authBaseUrl}}/api/ApiAuth/refresh", "host": [ "{{authBaseUrl}}" ], "path": [ "api", "ApiAuth", "refresh" ] }, "description": "Exchanges a still-valid access token + its refresh token for a new pair, without re-sending the API key. Use this once the access token has expired instead of calling Login again." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "if (body.Success) {", " pm.collectionVariables.set('accessToken', body.Data.AccessToken);", " pm.collectionVariables.set('refreshToken', body.Data.RefreshToken);", " console.log('Saved refreshed accessToken/refreshToken to collection variables.');", "} else {", " console.warn('Refresh failed:', body.Message);", "}" ] } } ] } ] }, { "name": "Customers", "item": [ { "name": "Customers", "item": [ { "name": "List customers", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers?page=1&pageSize=50&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in Name, CustomerCode and TaxNumber.", "disabled": true } ] }, "description": "Returns customers page by page. Sub-records (addresses, telephones, ...) are not included; use the detail endpoint for them." } }, { "name": "Create customer", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"CustomerCode\": \"0000382026\",\n \"Name\": \"Örnek Ticaret A.Ş.\",\n \"TaxNumber\": \"1234567890\",\n \"TaxOffice\": \"Kadıköy\",\n \"InvoiceTitle\": \"Örnek Ticaret Anonim Şirketi\",\n \"Note\": \"Deliveries on weekdays only.\",\n \"DueDays\": 30,\n \"DiscountRate\": 5,\n \"Blacklisted\": false,\n \"MovementType\": 2,\n \"RiskLimit\": 250000,\n \"RiskControl\": 1,\n \"RiskAction\": 1,\n \"EInvoiceUser\": true,\n \"EInvoiceScenario\": 1,\n \"ShipmentDefinitionCode\": \"KARAYOLU-1\",\n \"SharingCode\": \"\",\n \"ShowNoteOnQuote\": false,\n \"ShowNoteOnOrder\": false,\n \"ShowNoteOnDespatch\": true,\n \"ShowNoteOnInvoice\": false,\n \"IdentitySchemes\": [\n {\n \"SchemeID\": \"MERSISNO\",\n \"Value\": \"0123456789000015\"\n }\n ],\n \"Addresses\": [\n {\n \"District\": \"Kadıköy\",\n \"City\": \"İstanbul\",\n \"Country\": \"Türkiye\",\n \"Address\": \"Caferağa Mah. Moda Cad. No: 10\",\n \"PostalCode\": \"34710\",\n \"IsInvoiceAddress\": true,\n \"CoordinateX\": 40.9877,\n \"CoordinateY\": 29.0254\n }\n ],\n \"Telephones\": [\n {\n \"Number\": \"02165550000\",\n \"NumberType\": 1,\n \"Extension\": \"101\",\n \"Description\": \"Accounting\"\n }\n ],\n \"Links\": [\n {\n \"Value\": \"accounting@example.com\",\n \"LinkType\": 1,\n \"Description\": \"Invoices\"\n }\n ],\n \"Representatives\": [\n {\n \"FullName\": \"Ayşe Yılmaz\",\n \"Position\": \"Purchasing Manager\",\n \"Gsm\": \"05325550000\",\n \"Email\": \"ayse.yilmaz@example.com\",\n \"Phone\": \"02165550000\",\n \"Extension\": \"105\",\n \"Link\": \"https://www.linkedin.com/in/example\",\n \"Description\": \"\"\n }\n ],\n \"BankAccounts\": [\n {\n \"BankName\": \"Example Bank\",\n \"Branch\": \"Kadıköy\",\n \"AccountNumber\": \"12345678\",\n \"Iban\": \"TR330006100519786457841326\",\n \"CurrencyCode\": \"TRY\",\n \"Description\": \"\"\n }\n ],\n \"GroupMembers\": [\n {\n \"Group\": \"Region\",\n \"GroupDetail\": \"Marmara\"\n }\n ],\n \"Parameters\": [\n {\n \"ParameterName\": \"Segment\",\n \"Value\": \"Priority\"\n }\n ],\n \"QueryEInvoiceLabels\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers" ], "variable": [], "query": [] }, "description": "Creates the customer and its sub-records in a single transaction. If any sub-record is invalid, nothing is saved. Send an empty list for sub-records you do not need." } }, { "name": "Get customer", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Returns the customer with all sub-records: addresses, telephones, links, representatives, bank accounts, group memberships, parameters and e-invoice labels." } }, { "name": "Update customer", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"CustomerCode\": \"0000382026\",\n \"Name\": \"Örnek Ticaret A.Ş.\",\n \"TaxNumber\": \"1234567890\",\n \"TaxOffice\": \"Kadıköy\",\n \"InvoiceTitle\": \"Örnek Ticaret Anonim Şirketi\",\n \"Note\": \"Deliveries on weekdays only.\",\n \"DueDays\": 30,\n \"DiscountRate\": 5,\n \"Blacklisted\": false,\n \"MovementType\": 2,\n \"RiskLimit\": 250000,\n \"RiskControl\": 1,\n \"RiskAction\": 1,\n \"EInvoiceUser\": true,\n \"EInvoiceScenario\": 1,\n \"ShipmentDefinitionCode\": \"KARAYOLU-1\",\n \"SharingCode\": \"\",\n \"ShowNoteOnQuote\": false,\n \"ShowNoteOnOrder\": false,\n \"ShowNoteOnDespatch\": true,\n \"ShowNoteOnInvoice\": false,\n \"IdentitySchemes\": [\n {\n \"SchemeID\": \"MERSISNO\",\n \"Value\": \"0123456789000015\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Replaces the main customer fields. Sub-records are not changed; use their own endpoints." } }, { "name": "Partially update customer", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"CustomerCode\": \"0000382026\",\n \"Name\": \"Örnek Ticaret A.Ş.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Sub-records are not changed; use their own endpoints." } }, { "name": "Delete customer", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Deletes the customer together with its addresses, telephones, links, representatives, bank accounts, e-invoice labels, group memberships and parameters. Documents such as invoices and orders are not affected." } } ] }, { "name": "Customer Addresses", "item": [ { "name": "List addresses", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/addresses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "addresses" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Returns all addresses of the customer." } }, { "name": "Create address", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"District\": \"Kadıköy\",\n \"City\": \"İstanbul\",\n \"Country\": \"Türkiye\",\n \"Address\": \"Caferağa Mah. Moda Cad. No: 10\",\n \"PostalCode\": \"34710\",\n \"IsInvoiceAddress\": true,\n \"CoordinateX\": 40.9877,\n \"CoordinateY\": 29.0254\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/addresses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "addresses" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Adds a new address to the customer. If IsInvoiceAddress is true, the previous invoice address loses the flag. The first address of a customer is always the invoice address." } }, { "name": "Get address", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "addresses", ":addressId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "addressId", "value": "", "description": "Address ID." } ], "query": [] } } }, { "name": "Update address", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"District\": \"Kadıköy\",\n \"City\": \"İstanbul\",\n \"Country\": \"Türkiye\",\n \"Address\": \"Caferağa Mah. Moda Cad. No: 10\",\n \"PostalCode\": \"34710\",\n \"IsInvoiceAddress\": true,\n \"CoordinateX\": 40.9877,\n \"CoordinateY\": 29.0254\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "addresses", ":addressId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "addressId", "value": "", "description": "Address ID." } ], "query": [] }, "description": "Replaces all fields of the address. Fields that are not sent are cleared. If IsInvoiceAddress is true, the previous invoice address loses the flag. The first address of a customer is always the invoice address." } }, { "name": "Partially update address", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"District\": \"Kadıköy\",\n \"City\": \"İstanbul\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "addresses", ":addressId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "addressId", "value": "", "description": "Address ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete address", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "addresses", ":addressId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "addressId", "value": "", "description": "Address ID." } ], "query": [] }, "description": "Deletes the address. The invoice address cannot be deleted; mark another address as the invoice address first." } } ] }, { "name": "Customer Telephones", "item": [ { "name": "List telephones", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/telephones", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "telephones" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Returns all telephones of the customer." } }, { "name": "Create telephone", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Number\": \"02165550000\",\n \"NumberType\": 1,\n \"Extension\": \"101\",\n \"Description\": \"Accounting\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/telephones", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "telephones" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Adds a new telephone to the customer." } }, { "name": "Get telephone", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/telephones/:telephoneId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "telephones", ":telephoneId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "telephoneId", "value": "", "description": "Telephone ID." } ], "query": [] } } }, { "name": "Update telephone", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Number\": \"02165550000\",\n \"NumberType\": 1,\n \"Extension\": \"101\",\n \"Description\": \"Accounting\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/telephones/:telephoneId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "telephones", ":telephoneId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "telephoneId", "value": "", "description": "Telephone ID." } ], "query": [] }, "description": "Replaces all fields of the telephone. Fields that are not sent are cleared." } }, { "name": "Partially update telephone", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Number\": \"02165550000\",\n \"NumberType\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/telephones/:telephoneId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "telephones", ":telephoneId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "telephoneId", "value": "", "description": "Telephone ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete telephone", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/telephones/:telephoneId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "telephones", ":telephoneId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "telephoneId", "value": "", "description": "Telephone ID." } ], "query": [] }, "description": "Deletes the telephone." } } ] }, { "name": "Customer Links", "item": [ { "name": "List links", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/links", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "links" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Returns all links of the customer." } }, { "name": "Create link", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Value\": \"accounting@example.com\",\n \"LinkType\": 1,\n \"Description\": \"Invoices\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/links", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "links" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Adds a new link to the customer. If LinkType is 1 (e-mail), Value must be a valid e-mail address." } }, { "name": "Get link", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "links", ":linkId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "linkId", "value": "", "description": "Link ID." } ], "query": [] } } }, { "name": "Update link", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Value\": \"accounting@example.com\",\n \"LinkType\": 1,\n \"Description\": \"Invoices\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "links", ":linkId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "linkId", "value": "", "description": "Link ID." } ], "query": [] }, "description": "Replaces all fields of the link. Fields that are not sent are cleared. If LinkType is 1 (e-mail), Value must be a valid e-mail address." } }, { "name": "Partially update link", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Value\": \"accounting@example.com\",\n \"LinkType\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "links", ":linkId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "linkId", "value": "", "description": "Link ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete link", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "links", ":linkId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "linkId", "value": "", "description": "Link ID." } ], "query": [] }, "description": "Deletes the link." } } ] }, { "name": "Customer Representatives", "item": [ { "name": "List representatives", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/representatives", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "representatives" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Returns all representatives of the customer." } }, { "name": "Create representative", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"FullName\": \"Ayşe Yılmaz\",\n \"Position\": \"Purchasing Manager\",\n \"Gsm\": \"05325550000\",\n \"Email\": \"ayse.yilmaz@example.com\",\n \"Phone\": \"02165550000\",\n \"Extension\": \"105\",\n \"Link\": \"https://www.linkedin.com/in/example\",\n \"Description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/representatives", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "representatives" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Adds a new representative to the customer." } }, { "name": "Get representative", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/representatives/:representativeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "representatives", ":representativeId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "representativeId", "value": "", "description": "Representative ID." } ], "query": [] } } }, { "name": "Update representative", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"FullName\": \"Ayşe Yılmaz\",\n \"Position\": \"Purchasing Manager\",\n \"Gsm\": \"05325550000\",\n \"Email\": \"ayse.yilmaz@example.com\",\n \"Phone\": \"02165550000\",\n \"Extension\": \"105\",\n \"Link\": \"https://www.linkedin.com/in/example\",\n \"Description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/representatives/:representativeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "representatives", ":representativeId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "representativeId", "value": "", "description": "Representative ID." } ], "query": [] }, "description": "Replaces all fields of the representative. Fields that are not sent are cleared." } }, { "name": "Partially update representative", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"FullName\": \"Ayşe Yılmaz\",\n \"Position\": \"Purchasing Manager\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/representatives/:representativeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "representatives", ":representativeId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "representativeId", "value": "", "description": "Representative ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete representative", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/representatives/:representativeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "representatives", ":representativeId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "representativeId", "value": "", "description": "Representative ID." } ], "query": [] }, "description": "Deletes the representative." } } ] }, { "name": "Customer Bank Accounts", "item": [ { "name": "List bank accounts", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "bank-accounts" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Returns all bank accounts of the customer." } }, { "name": "Create bank account", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"BankName\": \"Example Bank\",\n \"Branch\": \"Kadıköy\",\n \"AccountNumber\": \"12345678\",\n \"Iban\": \"TR330006100519786457841326\",\n \"CurrencyCode\": \"TRY\",\n \"Description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "bank-accounts" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Adds a new bank account to the customer. Either Iban or both Branch and AccountNumber must be provided." } }, { "name": "Get bank account", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] } } }, { "name": "Update bank account", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"BankName\": \"Example Bank\",\n \"Branch\": \"Kadıköy\",\n \"AccountNumber\": \"12345678\",\n \"Iban\": \"TR330006100519786457841326\",\n \"CurrencyCode\": \"TRY\",\n \"Description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] }, "description": "Replaces all fields of the bank account. Fields that are not sent are cleared. Either Iban or both Branch and AccountNumber must be provided." } }, { "name": "Partially update bank account", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"BankName\": \"Example Bank\",\n \"Branch\": \"Kadıköy\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Either Iban or both Branch and AccountNumber must remain filled after the change." } }, { "name": "Delete bank account", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] }, "description": "Deletes the bank account." } } ] }, { "name": "Customer Group Members", "item": [ { "name": "List group memberships", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "group-members" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Returns all group memberships of the customer." } }, { "name": "Create group membership", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Group\": \"Region\",\n \"GroupDetail\": \"Marmara\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "group-members" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Adds a new group membership to the customer. A customer can be a member of the same group detail only once." } }, { "name": "Get group membership", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/group-members/:groupMemberId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "group-members", ":groupMemberId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "groupMemberId", "value": "", "description": "Group membership ID." } ], "query": [] } } }, { "name": "Update group membership", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Group\": \"Region\",\n \"GroupDetail\": \"Marmara\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/group-members/:groupMemberId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "group-members", ":groupMemberId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "groupMemberId", "value": "", "description": "Group membership ID." } ], "query": [] }, "description": "Replaces all fields of the group membership. Fields that are not sent are cleared. A customer can be a member of the same group detail only once." } }, { "name": "Partially update group membership", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Group\": \"Region\",\n \"GroupDetail\": \"Marmara\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/group-members/:groupMemberId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "group-members", ":groupMemberId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "groupMemberId", "value": "", "description": "Group membership ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete group membership", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/group-members/:groupMemberId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "group-members", ":groupMemberId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "groupMemberId", "value": "", "description": "Group membership ID." } ], "query": [] }, "description": "Deletes the group membership. Required-group rules are not checked on delete." } } ] }, { "name": "Customer Parameters", "item": [ { "name": "List parameter values", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "parameters" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Returns all parameter values of the customer." } }, { "name": "Create parameter value", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ParameterName\": \"Segment\",\n \"Value\": \"Priority\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "parameters" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [] }, "description": "Adds a new parameter value to the customer. A parameter definition can be used only once per customer. Value is interpreted according to the definition type." } }, { "name": "Get parameter value", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/parameters/:parameterId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "parameters", ":parameterId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "parameterId", "value": "", "description": "Parameter value ID." } ], "query": [] } } }, { "name": "Update parameter value", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ParameterName\": \"Segment\",\n \"Value\": \"Priority\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/parameters/:parameterId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "parameters", ":parameterId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "parameterId", "value": "", "description": "Parameter value ID." } ], "query": [] }, "description": "Replaces all fields of the parameter value. Fields that are not sent are cleared. A parameter definition can be used only once per customer. Value is interpreted according to the definition type." } }, { "name": "Partially update parameter value", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ParameterName\": \"Segment\",\n \"Value\": \"Priority\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/parameters/:parameterId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "parameters", ":parameterId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "parameterId", "value": "", "description": "Parameter value ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete parameter value", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:customerId/parameters/:parameterId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":customerId", "parameters", ":parameterId" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." }, { "key": "parameterId", "value": "", "description": "Parameter value ID." } ], "query": [] }, "description": "Deletes the parameter value." } } ] }, { "name": "Customer Definitions", "item": [ { "name": "List customer groups", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", "groups" ], "variable": [], "query": [] }, "description": "Returns the customer groups of the company with their details. Use a detail's Id as GroupDetailId in group memberships. When creating a customer, at least one detail from every group with IsMandatory = true must be sent." } }, { "name": "List customer parameter definitions", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/parameter-definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", "parameter-definitions" ], "variable": [], "query": [] }, "description": "Returns the customer parameter definitions of the company. Use an Id as ParameterDefinitionId in parameters; Type decides the format of Value." } }, { "name": "Create customer parameter definition", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"Segment\",\n \"Type\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/parameter-definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", "parameter-definitions" ], "variable": [], "query": [] }, "description": "Adds a parameter definition. Name must be unique within the company." } }, { "name": "Get customer parameter definition", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/parameter-definitions/:parameterDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", "parameter-definitions", ":parameterDefinitionId" ], "variable": [ { "key": "parameterDefinitionId", "value": "", "description": "Parameter definition ID." } ], "query": [] } } }, { "name": "Update customer parameter definition", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"Segment\",\n \"Type\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/parameter-definitions/:parameterDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", "parameter-definitions", ":parameterDefinitionId" ], "variable": [ { "key": "parameterDefinitionId", "value": "", "description": "Parameter definition ID." } ], "query": [] }, "description": "Replaces all fields of the parameter definition. Fields that are not sent are cleared." } }, { "name": "Partially update customer parameter definition", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"Segment\",\n \"Type\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/customers/parameter-definitions/:parameterDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", "parameter-definitions", ":parameterDefinitionId" ], "variable": [ { "key": "parameterDefinitionId", "value": "", "description": "Parameter definition ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete customer parameter definition", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/parameter-definitions/:parameterDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", "parameter-definitions", ":parameterDefinitionId" ], "variable": [ { "key": "parameterDefinitionId", "value": "", "description": "Parameter definition ID." } ], "query": [] }, "description": "Deletes the parameter definition. A definition used by a customer (in any customer's parameters) cannot be deleted." } } ] } ] }, { "name": "Products", "item": [ { "name": "Products", "item": [ { "name": "List products", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products?page=1&pageSize=50&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in Code, Name and Barcode.", "disabled": true } ] }, "description": "Returns products page by page, ordered by product code." } }, { "name": "Create product", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Code\": \"URN-0001\",\n \"Name\": \"VİDA 5X40 GALVANİZ\",\n \"UnitCode\": \"C62\",\n \"Barcode\": \"8690000000017\",\n \"ProductType\": 4,\n \"StockType\": 2,\n \"VatRate\": 20,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"IsOutOfUse\": false,\n \"ManufacturerCode\": \"\",\n \"SupplierCode\": \"\",\n \"Group1\": \"\",\n \"Group2\": \"\",\n \"Group3\": \"\",\n \"Group4\": \"\",\n \"Group5\": \"\",\n \"ShelfNumber\": \"A-12\",\n \"Description\": \"\",\n \"SerialNumberIndex\": 0,\n \"ECommerceProductCode\": \"\",\n \"IsFavourite\": false,\n \"Gtip\": \"7318159000\",\n \"DeliveryTerm\": \"EXW\",\n \"PackagingType\": \"BX\",\n \"TransportMode\": 3,\n \"Brand\": \"\",\n \"Model\": \"\",\n \"OriginCountryCode\": \"TR\",\n \"Parameters\": [\n {\n \"ParameterName\": \"Material\",\n \"Value\": \"Galvaniz\"\n }\n ],\n \"Prices\": [\n {\n \"PriceType\": 2,\n \"Price\": 450,\n \"CurrencyCode\": \"TRY\",\n \"IncludesVat\": false,\n \"Discount\": 10,\n \"IsDiscountPercentage\": true,\n \"UnitCode\": \"C62\",\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"CustomerCode\": \"\",\n \"CustomerGroup\": \"\",\n \"CustomerGroupDetail\": \"\",\n \"Description\": \"\"\n }\n ],\n \"CriticalStock\": [\n {\n \"WarehouseName\": \"MERKEZ DEPO\",\n \"MinStock\": 10,\n \"MaxStock\": 500,\n \"MaxStockControl\": 1,\n \"MinStockControl\": 1,\n \"NegativeStockControl\": 2\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ], "variable": [], "query": [] }, "description": "Creates a product and its sub-records (parameters, prices, critical stock) in one transaction. Code, Name and UnitId are required. Send Code as \"Next\" to generate the code from the \"ÜRÜN\" serial number definition." } }, { "name": "Get product", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] } } }, { "name": "Update product", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Code\": \"URN-0001\",\n \"Name\": \"VİDA 5X40 GALVANİZ\",\n \"UnitCode\": \"C62\",\n \"Barcode\": \"8690000000017\",\n \"ProductType\": 4,\n \"StockType\": 2,\n \"VatRate\": 20,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"IsOutOfUse\": false,\n \"ManufacturerCode\": \"\",\n \"SupplierCode\": \"\",\n \"Group1\": \"\",\n \"Group2\": \"\",\n \"Group3\": \"\",\n \"Group4\": \"\",\n \"Group5\": \"\",\n \"ShelfNumber\": \"A-12\",\n \"Description\": \"\",\n \"SerialNumberIndex\": 0,\n \"ECommerceProductCode\": \"\",\n \"IsFavourite\": false,\n \"Gtip\": \"7318159000\",\n \"DeliveryTerm\": \"EXW\",\n \"PackagingType\": \"BX\",\n \"TransportMode\": 3,\n \"Brand\": \"\",\n \"Model\": \"\",\n \"OriginCountryCode\": \"TR\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] }, "description": "Replaces all fields of the product. Fields that are not sent are cleared. Code cannot be \"Next\" on update." } }, { "name": "Partially update product", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Code\": \"URN-0001\",\n \"Name\": \"VİDA 5X40 GALVANİZ\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Code cannot be \"Next\"." } }, { "name": "Delete product", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] }, "description": "Deletes the product. A product used in invoices, orders, quotes, stock, purchasing, service or production records cannot be deleted." } } ] }, { "name": "Product Parameters", "item": [ { "name": "List parameter values", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "parameters" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] }, "description": "Returns all parameter values of the product." } }, { "name": "Create parameter value", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ParameterName\": \"Material\",\n \"Value\": \"Galvaniz\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "parameters" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] }, "description": "Adds a new parameter value to the product. A parameter definition can be used only once per product. Value is interpreted according to the definition type." } }, { "name": "Get parameter value", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/parameters/:parameterId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "parameters", ":parameterId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "parameterId", "value": "", "description": "Parameter value ID." } ], "query": [] } } }, { "name": "Update parameter value", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ParameterName\": \"Material\",\n \"Value\": \"Galvaniz\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/parameters/:parameterId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "parameters", ":parameterId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "parameterId", "value": "", "description": "Parameter value ID." } ], "query": [] }, "description": "Replaces all fields of the parameter value. Fields that are not sent are cleared. A parameter definition can be used only once per product. Value is interpreted according to the definition type." } }, { "name": "Partially update parameter value", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ParameterName\": \"Material\",\n \"Value\": \"Galvaniz\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/parameters/:parameterId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "parameters", ":parameterId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "parameterId", "value": "", "description": "Parameter value ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete parameter value", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/parameters/:parameterId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "parameters", ":parameterId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "parameterId", "value": "", "description": "Parameter value ID." } ], "query": [] }, "description": "Deletes the parameter value." } } ] }, { "name": "Product Parameter Definitions", "item": [ { "name": "List product parameter definitions", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/parameter-definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "parameter-definitions" ], "variable": [], "query": [] }, "description": "Returns the product parameter definitions of the company. Use an Id as ParameterDefinitionId in product parameters; Type decides the format of Value." } }, { "name": "Create product parameter definition", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"Malzeme\",\n \"Type\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/parameter-definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "parameter-definitions" ], "variable": [], "query": [] }, "description": "Adds a parameter definition. Name must be unique within the company." } }, { "name": "Get product parameter definition", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/parameter-definitions/:parameterDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "parameter-definitions", ":parameterDefinitionId" ], "variable": [ { "key": "parameterDefinitionId", "value": "", "description": "Parameter definition ID." } ], "query": [] } } }, { "name": "Update product parameter definition", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"Malzeme\",\n \"Type\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/parameter-definitions/:parameterDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "parameter-definitions", ":parameterDefinitionId" ], "variable": [ { "key": "parameterDefinitionId", "value": "", "description": "Parameter definition ID." } ], "query": [] }, "description": "Replaces all fields of the parameter definition. Fields that are not sent are cleared." } }, { "name": "Partially update product parameter definition", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"Malzeme\",\n \"Type\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/parameter-definitions/:parameterDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "parameter-definitions", ":parameterDefinitionId" ], "variable": [ { "key": "parameterDefinitionId", "value": "", "description": "Parameter definition ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete product parameter definition", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/parameter-definitions/:parameterDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "parameter-definitions", ":parameterDefinitionId" ], "variable": [ { "key": "parameterDefinitionId", "value": "", "description": "Parameter definition ID." } ], "query": [] }, "description": "Deletes the parameter definition. A definition used by a product (in any product's parameters) cannot be deleted." } } ] }, { "name": "Product Prices", "item": [ { "name": "List prices", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/prices", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "prices" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] }, "description": "Returns all price/discount rows of the product." } }, { "name": "Create price", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"PriceType\": 2,\n \"Price\": 450,\n \"CurrencyCode\": \"TRY\",\n \"IncludesVat\": false,\n \"Discount\": 10,\n \"IsDiscountPercentage\": true,\n \"UnitCode\": \"C62\",\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"CustomerCode\": \"\",\n \"CustomerGroup\": \"\",\n \"CustomerGroupDetail\": \"\",\n \"Description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/prices", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "prices" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] }, "description": "Adds a new price/discount row to the product. PriceType, Price, CurrencyId, StartDate and EndDate are required." } }, { "name": "Get price", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "prices", ":priceId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "priceId", "value": "", "description": "Price ID." } ], "query": [] } } }, { "name": "Update price", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"PriceType\": 2,\n \"Price\": 450,\n \"CurrencyCode\": \"TRY\",\n \"IncludesVat\": false,\n \"Discount\": 10,\n \"IsDiscountPercentage\": true,\n \"UnitCode\": \"C62\",\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"CustomerCode\": \"\",\n \"CustomerGroup\": \"\",\n \"CustomerGroupDetail\": \"\",\n \"Description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "prices", ":priceId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "priceId", "value": "", "description": "Price ID." } ], "query": [] }, "description": "Replaces all fields of the price. Fields that are not sent are cleared." } }, { "name": "Partially update price", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"PriceType\": 2,\n \"Price\": 450\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "prices", ":priceId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "priceId", "value": "", "description": "Price ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete price", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "prices", ":priceId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "priceId", "value": "", "description": "Price ID." } ], "query": [] }, "description": "Deletes the price/discount row." } } ] }, { "name": "Product Critical Stock", "item": [ { "name": "List critical stock definitions", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/critical-stock", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "critical-stock" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] }, "description": "Returns all critical stock definitions of the product, one per warehouse." } }, { "name": "Create critical stock definition", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"MERKEZ DEPO\",\n \"MinStock\": 10,\n \"MaxStock\": 500,\n \"MaxStockControl\": 1,\n \"MinStockControl\": 1,\n \"NegativeStockControl\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/critical-stock", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "critical-stock" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [] }, "description": "Adds a critical stock definition to the product for a warehouse. A product can have at most one definition per warehouse." } }, { "name": "Get critical stock definition", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/critical-stock/:criticalStockId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "critical-stock", ":criticalStockId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "criticalStockId", "value": "", "description": "Critical stock definition ID." } ], "query": [] } } }, { "name": "Update critical stock definition", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"MERKEZ DEPO\",\n \"MinStock\": 10,\n \"MaxStock\": 500,\n \"MaxStockControl\": 1,\n \"MinStockControl\": 1,\n \"NegativeStockControl\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/critical-stock/:criticalStockId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "critical-stock", ":criticalStockId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "criticalStockId", "value": "", "description": "Critical stock definition ID." } ], "query": [] }, "description": "Replaces all fields of the critical stock definition. Fields that are not sent are cleared." } }, { "name": "Partially update critical stock definition", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"MERKEZ DEPO\",\n \"MinStock\": 10\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/critical-stock/:criticalStockId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "critical-stock", ":criticalStockId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "criticalStockId", "value": "", "description": "Critical stock definition ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete critical stock definition", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:productId/critical-stock/:criticalStockId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":productId", "critical-stock", ":criticalStockId" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." }, { "key": "criticalStockId", "value": "", "description": "Critical stock definition ID." } ], "query": [] }, "description": "Deletes the critical stock definition." } } ] }, { "name": "Product groups", "item": [ { "name": "List product group details", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/groups?groupNumber=&parentGroup=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "groups" ], "variable": [], "query": [ { "key": "groupNumber", "value": "", "description": "Returns only the details of this group (1-5).", "disabled": true }, { "key": "parentGroup", "value": "", "description": "Name of a detail of the previous group (groupNumber - 1). Returns only the details whose parent is this detail, plus the details without a parent.", "disabled": true } ] }, "description": "Returns the selectable values of the five product groups. Use a name as Group1...Group5 in products.\nSend parentGroup together with groupNumber to get exactly the details that can be selected under that parent:\nthe children of the parent plus the details that have no parent." } }, { "name": "Create product group detail", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"GroupNumber\": 2,\n \"Name\": \"SEDAN\",\n \"ParentGroup\": \"AUDİ\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "groups" ], "variable": [], "query": [] }, "description": "Adds a detail to a product group. Name must be unique within the group.\nParentGroupDetailId must be a detail of the previous group; leave it empty to make the detail selectable under every parent." } }, { "name": "Get product group detail", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/groups/:groupDetailId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "groups", ":groupDetailId" ], "variable": [ { "key": "groupDetailId", "value": "", "description": "Product group detail ID." } ], "query": [] } } }, { "name": "Update product group detail", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"GroupNumber\": 2,\n \"Name\": \"SEDAN\",\n \"ParentGroup\": \"AUDİ\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/groups/:groupDetailId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "groups", ":groupDetailId" ], "variable": [ { "key": "groupDetailId", "value": "", "description": "Product group detail ID." } ], "query": [] }, "description": "Replaces all fields of the group detail. Fields that are not sent are cleared, so sending no ParentGroupDetailId makes the detail selectable under every parent. GroupNumber and ParentGroupDetailId cannot be changed while other details use this detail as their parent." } }, { "name": "Partially update product group detail", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"GroupNumber\": 2,\n \"Name\": \"SEDAN\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/products/groups/:groupDetailId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "groups", ":groupDetailId" ], "variable": [ { "key": "groupDetailId", "value": "", "description": "Product group detail ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete product group detail", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/products/groups/:groupDetailId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", "groups", ":groupDetailId" ], "variable": [ { "key": "groupDetailId", "value": "", "description": "Product group detail ID." } ], "query": [] }, "description": "Deletes the group detail. A detail that has child details in the next group, or that is used by products, cannot be deleted." } } ] } ] }, { "name": "Definitions", "item": [ { "name": "Countries", "item": [ { "name": "List countries", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/countries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "countries" ], "variable": [], "query": [] }, "description": "Returns the countries of the company. The default country comes first." } }, { "name": "Create country", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"TÜRKİYE\",\n \"Code\": \"TR\",\n \"Nationality\": \"TÜRK\",\n \"IsDefault\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/countries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "countries" ], "variable": [], "query": [] }, "description": "Adds a country. Name must be unique within the company. If IsDefault is true, the previous default country loses the flag." } }, { "name": "Get country", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/countries/:countryId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "countries", ":countryId" ], "variable": [ { "key": "countryId", "value": "", "description": "Country ID." } ], "query": [] } } }, { "name": "Update country", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"TÜRKİYE\",\n \"Code\": \"TR\",\n \"Nationality\": \"TÜRK\",\n \"IsDefault\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/countries/:countryId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "countries", ":countryId" ], "variable": [ { "key": "countryId", "value": "", "description": "Country ID." } ], "query": [] }, "description": "Replaces all fields of the country. Fields that are not sent are cleared." } }, { "name": "Partially update country", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"TÜRKİYE\",\n \"Code\": \"TR\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/countries/:countryId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "countries", ":countryId" ], "variable": [ { "key": "countryId", "value": "", "description": "Country ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete country", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/countries/:countryId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "countries", ":countryId" ], "variable": [ { "key": "countryId", "value": "", "description": "Country ID." } ], "query": [] }, "description": "Deletes the country. A country that still has cities cannot be deleted." } } ] }, { "name": "Cities", "item": [ { "name": "List cities", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/cities?country=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "cities" ], "variable": [], "query": [ { "key": "country", "value": "", "description": "Returns only the cities of this country (country name).", "disabled": true } ] }, "description": "Returns the cities of the company, optionally filtered by country." } }, { "name": "Create city", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Country\": \"TÜRKİYE\",\n \"Name\": \"ISTANBUL\",\n \"AreaCode\": \"216\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/cities", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "cities" ], "variable": [], "query": [] }, "description": "Adds a city to a country. Name must be unique within the country." } }, { "name": "Get city", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/cities/:cityId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "cities", ":cityId" ], "variable": [ { "key": "cityId", "value": "", "description": "City ID." } ], "query": [] } } }, { "name": "Update city", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Country\": \"TÜRKİYE\",\n \"Name\": \"ISTANBUL\",\n \"AreaCode\": \"216\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/cities/:cityId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "cities", ":cityId" ], "variable": [ { "key": "cityId", "value": "", "description": "City ID." } ], "query": [] }, "description": "Replaces all fields of the city. Fields that are not sent are cleared." } }, { "name": "Partially update city", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Country\": \"TÜRKİYE\",\n \"Name\": \"ISTANBUL\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/cities/:cityId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "cities", ":cityId" ], "variable": [ { "key": "cityId", "value": "", "description": "City ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete city", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/cities/:cityId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "cities", ":cityId" ], "variable": [ { "key": "cityId", "value": "", "description": "City ID." } ], "query": [] }, "description": "Deletes the city. A city that still has districts cannot be deleted." } } ] }, { "name": "Districts", "item": [ { "name": "List districts", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/districts?city=&country=&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "districts" ], "variable": [], "query": [ { "key": "city", "value": "", "description": "Returns only the districts of this city (city name).", "disabled": true }, { "key": "country", "value": "", "description": "Country name of the city. Needed only when the same city name exists in more than one country.", "disabled": true }, { "key": "search", "value": "", "description": "Searches in the district name.", "disabled": true } ] }, "description": "Returns the districts of the company." } }, { "name": "Create district", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"City\": \"İSTANBUL\",\n \"Country\": \"TÜRKİYE\",\n \"Name\": \"KADIKÖY\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/districts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "districts" ], "variable": [], "query": [] }, "description": "Adds a district to a city. Name must be unique within the city." } }, { "name": "Get district", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/districts/:districtId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "districts", ":districtId" ], "variable": [ { "key": "districtId", "value": "", "description": "District ID." } ], "query": [] } } }, { "name": "Update district", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"City\": \"İSTANBUL\",\n \"Country\": \"TÜRKİYE\",\n \"Name\": \"KADIKÖY\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/districts/:districtId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "districts", ":districtId" ], "variable": [ { "key": "districtId", "value": "", "description": "District ID." } ], "query": [] }, "description": "Replaces all fields of the district. Fields that are not sent are cleared." } }, { "name": "Partially update district", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"City\": \"İSTANBUL\",\n \"Country\": \"TÜRKİYE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/districts/:districtId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "districts", ":districtId" ], "variable": [ { "key": "districtId", "value": "", "description": "District ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete district", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/districts/:districtId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "districts", ":districtId" ], "variable": [ { "key": "districtId", "value": "", "description": "District ID." } ], "query": [] }, "description": "Deletes the district. A district used in customer addresses cannot be deleted." } } ] }, { "name": "Currencies", "item": [ { "name": "List currencies", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/currencies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "currencies" ], "variable": [], "query": [] }, "description": "Returns the currencies of the company. The default currency comes first. Use a currency's Id as CurrencyId in customer bank accounts." } }, { "name": "Create currency", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"TÜRK LİRASI\",\n \"Code\": \"TRY\",\n \"SubunitName\": \"KURUŞ\",\n \"IsDefault\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/currencies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "currencies" ], "variable": [], "query": [] }, "description": "Adds a currency. Name and Code must be unique within the company. If IsDefault is true, the previous default currency loses the flag." } }, { "name": "Get currency", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/currencies/:currencyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "currencies", ":currencyId" ], "variable": [ { "key": "currencyId", "value": "", "description": "Currency ID." } ], "query": [] } } }, { "name": "Update currency", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"TÜRK LİRASI\",\n \"Code\": \"TRY\",\n \"SubunitName\": \"KURUŞ\",\n \"IsDefault\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/currencies/:currencyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "currencies", ":currencyId" ], "variable": [ { "key": "currencyId", "value": "", "description": "Currency ID." } ], "query": [] }, "description": "Replaces all fields of the currency. Fields that are not sent are cleared." } }, { "name": "Partially update currency", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"TÜRK LİRASI\",\n \"Code\": \"TRY\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/currencies/:currencyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "currencies", ":currencyId" ], "variable": [ { "key": "currencyId", "value": "", "description": "Currency ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete currency", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/currencies/:currencyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "currencies", ":currencyId" ], "variable": [ { "key": "currencyId", "value": "", "description": "Currency ID." } ], "query": [] }, "description": "Deletes the currency. The default currency, and a currency used in customer or financial records, cannot be deleted." } } ] }, { "name": "Units", "item": [ { "name": "List units", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/units", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "units" ], "variable": [], "query": [] }, "description": "Returns the units of the company. Use a unit Id as UnitId in products." } }, { "name": "Create unit", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"ADET\",\n \"UniversalCode\": \"C62\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/units", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "units" ], "variable": [], "query": [] }, "description": "Adds a unit. Name must be unique within the company." } }, { "name": "Get unit", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/units/:unitId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "units", ":unitId" ], "variable": [ { "key": "unitId", "value": "", "description": "Unit ID." } ], "query": [] } } }, { "name": "Update unit", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"ADET\",\n \"UniversalCode\": \"C62\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/units/:unitId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "units", ":unitId" ], "variable": [ { "key": "unitId", "value": "", "description": "Unit ID." } ], "query": [] }, "description": "Replaces all fields of the unit. Fields that are not sent are cleared." } }, { "name": "Partially update unit", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"ADET\",\n \"UniversalCode\": \"C62\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/units/:unitId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "units", ":unitId" ], "variable": [ { "key": "unitId", "value": "", "description": "Unit ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete unit", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/units/:unitId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "units", ":unitId" ], "variable": [ { "key": "unitId", "value": "", "description": "Unit ID." } ], "query": [] }, "description": "Deletes the unit. A unit used as the main unit of a product cannot be deleted." } } ] }, { "name": "Line Groups", "item": [ { "name": "List line groups", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/line-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "line-groups" ], "variable": [], "query": [] }, "description": "Returns the line groups of the company. Use a line group Id as LineGroupId in quote lines." } }, { "name": "Create line group", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"Main items\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/line-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "line-groups" ], "variable": [], "query": [] }, "description": "Adds a line group. Name must be unique within the company." } }, { "name": "Get line group", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/line-groups/:lineGroupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "line-groups", ":lineGroupId" ], "variable": [ { "key": "lineGroupId", "value": "", "description": "Line group ID." } ], "query": [] } } }, { "name": "Update line group", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"Main items\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/line-groups/:lineGroupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "line-groups", ":lineGroupId" ], "variable": [ { "key": "lineGroupId", "value": "", "description": "Line group ID." } ], "query": [] }, "description": "Replaces all fields of the line group. Fields that are not sent are cleared." } }, { "name": "Partially update line group", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"Main items\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/line-groups/:lineGroupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "line-groups", ":lineGroupId" ], "variable": [ { "key": "lineGroupId", "value": "", "description": "Line group ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete line group", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/line-groups/:lineGroupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "line-groups", ":lineGroupId" ], "variable": [ { "key": "lineGroupId", "value": "", "description": "Line group ID." } ], "query": [] }, "description": "Deletes the line group. A line group used by quote lines or other records cannot be deleted." } } ] }, { "name": "Shipment Definitions", "item": [ { "name": "List shipment definitions", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/shipment-definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "shipment-definitions" ], "variable": [], "query": [] }, "description": "Returns the shipment definitions of the company. Use an Id as ShipmentDefinitionId in customers." } }, { "name": "Create shipment definition", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Code\": \"5469\",\n \"Description\": \"Istanbul road shipments\",\n \"TransportMode\": 1,\n \"TransportInfo1\": \"34ABC123\",\n \"TransportInfo2\": \"\",\n \"CarrierName\": \"Example Logistics Ltd.\",\n \"CarrierTaxNumber\": \"1234567890\",\n \"CarrierCity\": \"ISTANBUL\",\n \"CarrierDistrict\": \"KADIKÖY\",\n \"CarrierCountry\": \"TÜRKİYE\",\n \"Driver1FirstName\": \"Ahmet\",\n \"Driver1LastName\": \"Kaya\",\n \"Driver1IdentityNumber\": \"12345678901\",\n \"Driver2FirstName\": \"\",\n \"Driver2LastName\": \"\",\n \"Driver2IdentityNumber\": \"\",\n \"TrailerPlate1\": \"34ABC123\",\n \"TrailerPlate2\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/shipment-definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "shipment-definitions" ], "variable": [], "query": [] }, "description": "Adds a shipment definition. Code must be unique within the company; TransportMode must be 1-4." } }, { "name": "Get shipment definition", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/shipment-definitions/:shipmentDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "shipment-definitions", ":shipmentDefinitionId" ], "variable": [ { "key": "shipmentDefinitionId", "value": "", "description": "Shipment definition ID." } ], "query": [] } } }, { "name": "Update shipment definition", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Code\": \"5469\",\n \"Description\": \"Istanbul road shipments\",\n \"TransportMode\": 1,\n \"TransportInfo1\": \"34ABC123\",\n \"TransportInfo2\": \"\",\n \"CarrierName\": \"Example Logistics Ltd.\",\n \"CarrierTaxNumber\": \"1234567890\",\n \"CarrierCity\": \"ISTANBUL\",\n \"CarrierDistrict\": \"KADIKÖY\",\n \"CarrierCountry\": \"TÜRKİYE\",\n \"Driver1FirstName\": \"Ahmet\",\n \"Driver1LastName\": \"Kaya\",\n \"Driver1IdentityNumber\": \"12345678901\",\n \"Driver2FirstName\": \"\",\n \"Driver2LastName\": \"\",\n \"Driver2IdentityNumber\": \"\",\n \"TrailerPlate1\": \"34ABC123\",\n \"TrailerPlate2\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/shipment-definitions/:shipmentDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "shipment-definitions", ":shipmentDefinitionId" ], "variable": [ { "key": "shipmentDefinitionId", "value": "", "description": "Shipment definition ID." } ], "query": [] }, "description": "Replaces all fields of the shipment definition. Fields that are not sent are cleared." } }, { "name": "Partially update shipment definition", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Code\": \"5469\",\n \"Description\": \"Istanbul road shipments\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/definitions/shipment-definitions/:shipmentDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "shipment-definitions", ":shipmentDefinitionId" ], "variable": [ { "key": "shipmentDefinitionId", "value": "", "description": "Shipment definition ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. The carrier company and driver rules are checked on the merged record, so clearing one carrier field alone is rejected." } }, { "name": "Delete shipment definition", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/shipment-definitions/:shipmentDefinitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "shipment-definitions", ":shipmentDefinitionId" ], "variable": [ { "key": "shipmentDefinitionId", "value": "", "description": "Shipment definition ID." } ], "query": [] }, "description": "Deletes the shipment definition. A shipment definition used by customers cannot be deleted." } } ] }, { "name": "VAT rates", "item": [ { "name": "List VAT rates", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/definitions/vat-rates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "definitions", "vat-rates" ], "variable": [], "query": [] }, "description": "Returns the VAT rates of the company, ordered by rate. Use an Id as VatRateId in products." } } ] } ] }, { "name": "Stock", "item": [ { "name": "Warehouses", "item": [ { "name": "List warehouses", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses" ], "variable": [], "query": [] }, "description": "Returns the warehouses of the company. The default warehouse comes first. Use a warehouse's Id as WarehouseId in sections and in a product's critical stock definitions." } }, { "name": "Create warehouse", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"A DEPO\",\n \"IsDefault\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses" ], "variable": [], "query": [] }, "description": "Adds a warehouse. Name must be unique within the company. If IsDefault is true, the previous default warehouse loses the flag." } }, { "name": "Get warehouse", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." } ], "query": [] } } }, { "name": "Update warehouse", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"A DEPO\",\n \"IsDefault\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." } ], "query": [] }, "description": "Replaces all fields of the warehouse. Fields that are not sent are cleared." } }, { "name": "Partially update warehouse", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"A DEPO\",\n \"IsDefault\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete warehouse", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." } ], "query": [] }, "description": "Deletes the warehouse. A warehouse that has sections, or is used in a record (invoice, order, stock count, critical stock definition, ...), cannot be deleted." } } ] }, { "name": "Sections", "item": [ { "name": "List sections", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId/sections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId", "sections" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." } ], "query": [] }, "description": "Returns all sections of the warehouse." } }, { "name": "Create section", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"RAF 1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId/sections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId", "sections" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." } ], "query": [] }, "description": "Adds a new section to the warehouse. Name must be unique within the warehouse." } }, { "name": "Get section", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId", "sections", ":sectionId" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." }, { "key": "sectionId", "value": "", "description": "Section ID." } ], "query": [] } } }, { "name": "Update section", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"RAF 1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId", "sections", ":sectionId" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." }, { "key": "sectionId", "value": "", "description": "Section ID." } ], "query": [] }, "description": "Replaces all fields of the section. Fields that are not sent are cleared." } }, { "name": "Partially update section", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"RAF 1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId", "sections", ":sectionId" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." }, { "key": "sectionId", "value": "", "description": "Section ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete section", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/warehouses/:warehouseId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "warehouses", ":warehouseId", "sections", ":sectionId" ], "variable": [ { "key": "warehouseId", "value": "", "description": "Warehouse ID." }, { "key": "sectionId", "value": "", "description": "Section ID." } ], "query": [] }, "description": "Deletes the section. A section used in a record (warehouse slip, stock count, ...) cannot be deleted." } } ] }, { "name": "Product Stock Status", "item": [ { "name": "Get product stock status", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/stock/products/:productId/status?warehouseName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stock", "products", ":productId", "status" ], "variable": [ { "key": "productId", "value": "", "description": "Product ID." } ], "query": [ { "key": "warehouseName", "value": "", "description": "Only count movements in this warehouse (name from GET /api/v1/stock/warehouses). When empty, all warehouses are included.", "disabled": true } ] }, "description": "Returns the product's total quantity on hand and, depending on its StockType, a breakdown by remaining lot quantity or by serial numbers still in stock. Read-only report; nothing here can be created, updated or deleted through the API." } } ] } ] }, { "name": "Quotes", "item": [ { "name": "List quotes", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/quotes?page=1&pageSize=50&search="eType=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quotes" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in QuoteNumber, DocumentNumber and the customer name.", "disabled": true }, { "key": "quoteType", "value": "", "description": "Returns only quotes of this type: 1 purchase, 2 sales.", "disabled": true } ] }, "description": "Returns quotes page by page, newest first, without their lines. Use Get quote to read the lines." } }, { "name": "Create quote", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"QuoteType\": 2,\n \"QuoteNumber\": \"52825CA9F1\",\n \"DocumentNumber\": \"2026-15\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"RepresentativeName\": \"\",\n \"DueDays\": 30,\n \"DeliveryDate\": \"2026-01-15T10:30:00\",\n \"SharingCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 1000,\n \"VatTotal\": 200,\n \"AdditionalTaxTotal\": 0,\n \"WithholdingTotal\": 0,\n \"GrandTotal\": 1200,\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"DeliveryDate\": \"2026-01-15T10:30:00\",\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/quotes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quotes" ], "variable": [], "query": [] }, "description": "Creates a quote with its lines and their discounts in one transaction. The API does not calculate or cross-check amounts: send the line amounts and the quote totals as calculated by your system (see the calculations page). Send QuoteNumber as \"Next\" to generate it from the number series of the quote type." } }, { "name": "Get quote", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/quotes/:quoteId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quotes", ":quoteId" ], "variable": [ { "key": "quoteId", "value": "", "description": "Quote ID." } ], "query": [] }, "description": "Returns the quote with its lines and their discounts." } }, { "name": "Update quote", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"QuoteType\": 2,\n \"QuoteNumber\": \"52825CA9F1\",\n \"DocumentNumber\": \"2026-15\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"RepresentativeName\": \"\",\n \"DueDays\": 30,\n \"DeliveryDate\": \"2026-01-15T10:30:00\",\n \"SharingCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 1000,\n \"VatTotal\": 200,\n \"AdditionalTaxTotal\": 0,\n \"WithholdingTotal\": 0,\n \"GrandTotal\": 1200,\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"DeliveryDate\": \"2026-01-15T10:30:00\",\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/quotes/:quoteId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quotes", ":quoteId" ], "variable": [ { "key": "quoteId", "value": "", "description": "Quote ID." } ], "query": [] }, "description": "Replaces all fields of the quote, and replaces its lines: the existing lines are removed and the lines in the request are saved. QuoteType cannot be changed and QuoteNumber cannot be \"Next\". The quote status is never changed by the API." } }, { "name": "Partially update quote", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"QuoteType\": 2,\n \"QuoteNumber\": \"52825CA9F1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/quotes/:quoteId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quotes", ":quoteId" ], "variable": [ { "key": "quoteId", "value": "", "description": "Quote ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines, when it is not sent the lines stay as they are." } }, { "name": "Delete quote", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/quotes/:quoteId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "quotes", ":quoteId" ], "variable": [ { "key": "quoteId", "value": "", "description": "Quote ID." } ], "query": [] }, "description": "Deletes the quote and its lines. A quote that other records (for example service slips or opportunities) refer to cannot be deleted." } } ] }, { "name": "Orders", "item": [ { "name": "List orders", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/orders?page=1&pageSize=50&search=&orderType=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in OrderNumber, DocumentNumber and the customer name.", "disabled": true }, { "key": "orderType", "value": "", "description": "Returns only orders of this type: 1 purchase, 2 sales.", "disabled": true } ] }, "description": "Returns orders page by page, newest first, without their lines. Use Get order to read the lines." } }, { "name": "Create order", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"OrderType\": 2,\n \"OrderNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"2026-15\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 30,\n \"DeliveryDate\": \"2026-01-15T10:30:00\",\n \"SharingCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 1000,\n \"VatTotal\": 200,\n \"AdditionalTaxTotal\": 0,\n \"WithholdingTotal\": 0,\n \"GrandTotal\": 1200,\n \"CreateCustomerMovement\": true,\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"DeliveryDate\": \"2026-01-15T10:30:00\",\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders" ], "variable": [], "query": [] }, "description": "Creates an order with its lines and their discounts in one transaction. The API does not calculate or cross-check amounts: send the line amounts and the order totals as calculated by your system (see the calculations page of quotes, which use the same rules). The quantity of each line in the product's main unit is calculated by the API. Send OrderNumber as \"Next\" to generate it from the number series of the order type. When CreateCustomerMovement is true, the customer movement is written in the same transaction. The approvals required by the company's approval definitions and the company's default order status are also assigned automatically." } }, { "name": "Get order", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "Order ID." } ], "query": [] }, "description": "Returns the order with its lines and their discounts." } }, { "name": "Update order", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"OrderType\": 2,\n \"OrderNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"2026-15\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 30,\n \"DeliveryDate\": \"2026-01-15T10:30:00\",\n \"SharingCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 1000,\n \"VatTotal\": 200,\n \"AdditionalTaxTotal\": 0,\n \"WithholdingTotal\": 0,\n \"GrandTotal\": 1200,\n \"CreateCustomerMovement\": true,\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"DeliveryDate\": \"2026-01-15T10:30:00\",\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "Order ID." } ], "query": [] }, "description": "Replaces all fields of the order, and replaces its lines: the existing lines are removed and the lines in the request are saved. OrderType cannot be changed while the order has a customer movement and OrderNumber cannot be \"Next\". CreateCustomerMovement decides the customer movement: true creates it or brings it in line with the order, false removes an existing one. A movement that has already been closed by a collection or payment cannot be removed, and its customer, currency and amount cannot be changed. The order status and approvals are never changed by an update." } }, { "name": "Partially update order", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"OrderType\": 2,\n \"OrderNumber\": \"9446A4D834\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "Order ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines, when it is not sent the lines stay as they are. The customer movement follows CreateCustomerMovement exactly as in a full update." } }, { "name": "Delete order", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "Order ID." } ], "query": [] }, "description": "Deletes the order, its lines and its customer movement. An order whose customer movement has been closed by a collection or payment, or that other records (for example quotes or opportunities) refer to, cannot be deleted." } } ] }, { "name": "Despatches", "item": [ { "name": "List despatches", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/despatches?page=1&pageSize=50&search=&despatchType=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "despatches" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in DespatchNumber, DocumentNumber and the customer name.", "disabled": true }, { "key": "despatchType", "value": "", "description": "Returns only despatches of this type: 2 inbound, -2 outbound.", "disabled": true } ] }, "description": "Returns despatches page by page, newest first, without their lines. Use Get despatch to read the lines." } }, { "name": "Create despatch", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"DespatchType\": -2,\n \"DespatchNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"2026-15\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"ActualDispatchDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 30,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 1000,\n \"VatTotal\": 200,\n \"AdditionalTaxTotal\": 0,\n \"WithholdingTotal\": 0,\n \"GrandTotal\": 1200,\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"0000000109\",\n \"Quantity\": 10,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/despatches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "despatches" ], "variable": [], "query": [] }, "description": "Creates a despatch with its lines, their discounts, and their Lot/serial number entries in one transaction. The API does not calculate or cross-check amounts: send the line amounts and the despatch totals as calculated by your system. The quantity of each line in the product's main unit is calculated by the API. The address, title, tax number and tax office are copied from the customer and are not accepted in the request. Send DespatchNumber as \"Next\" to generate it automatically (from the number series of the despatch type, or from the e-Despatch numbering for an outbound despatch when the company uses e-Despatch)." } }, { "name": "Get despatch", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/despatches/:despatchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "despatches", ":despatchId" ], "variable": [ { "key": "despatchId", "value": "", "description": "Despatch ID." } ], "query": [] }, "description": "Returns the despatch with its lines, their discounts, and their Lot/serial number entries." } }, { "name": "Update despatch", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"DespatchType\": -2,\n \"DespatchNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"2026-15\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"ActualDispatchDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 30,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 1000,\n \"VatTotal\": 200,\n \"AdditionalTaxTotal\": 0,\n \"WithholdingTotal\": 0,\n \"GrandTotal\": 1200,\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"0000000109\",\n \"Quantity\": 10,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/despatches/:despatchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "despatches", ":despatchId" ], "variable": [ { "key": "despatchId", "value": "", "description": "Despatch ID." } ], "query": [] }, "description": "Replaces all fields of the despatch, and replaces its lines: the order in which lines are sent determines their identity (the line at the same position as an existing line is treated as that line - its Lot/serial number and linked-order records move with it), a shorter list removes the trailing lines, a longer list adds new ones at the end. DespatchType cannot be changed and DespatchNumber cannot be \"Next\"." } }, { "name": "Partially update despatch", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"DespatchType\": -2,\n \"DespatchNumber\": \"9446A4D834\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/despatches/:despatchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "despatches", ":despatchId" ], "variable": [ { "key": "despatchId", "value": "", "description": "Despatch ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines (with the same line-identity rule as a full update), when it is not sent the lines stay as they are." } }, { "name": "Delete despatch", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/despatches/:despatchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "despatches", ":despatchId" ], "variable": [ { "key": "despatchId", "value": "", "description": "Despatch ID." } ], "query": [] }, "description": "Deletes the despatch and its lines. A Lot that has already been consumed by an outbound transaction, or a serial number that has already been dispatched, blocks the deletion of the line it belongs to. A despatch referenced by other records cannot be deleted." } } ] }, { "name": "Invoices", "item": [ { "name": "Purchase Invoices", "item": [ { "name": "List purchase invoices", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/purchase-invoices?page=1&pageSize=50&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-invoices" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in InvoiceNumber, DocumentNumber and the customer name.", "disabled": true } ] }, "description": "Returns purchase invoices page by page, newest first, without their lines. Use Get purchase invoice to read the lines." } }, { "name": "Create purchase invoice", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 0,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 0,\n \"VatTotal\": 0,\n \"GrandTotal\": 0,\n \"Consolidated\": false,\n \"PrintDescription\": false,\n \"Cancelled\": false,\n \"ApplyWithholding\": false,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithholdingTotal\": 0,\n \"AdditionalTaxTotal\": 0,\n \"ProfileId\": \"\",\n \"InvoiceTypeCode\": \"\",\n \"WithholdingTaxRate\": 0,\n \"SocialSecurityRate\": 0,\n \"MarketRate\": 0,\n \"ReturnedInvoiceNumber\": \"\",\n \"ReturnedInvoiceDate\": \"2026-01-15T10:30:00\",\n \"OrderReferenceNumber\": \"\",\n \"OrderReferenceDate\": \"2026-01-15T10:30:00\",\n \"BranchNumber\": \"\",\n \"BranchTitle\": \"\",\n \"BranchAddress\": \"\",\n \"InvestmentIncentiveDocumentNumber\": \"\",\n \"InvestmentIncentiveDocumentDate\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodStart\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodEnd\": \"2026-01-15T10:30:00\",\n \"DeliveryInfo\": {\n \"DeliveryTerm\": \"\",\n \"TransportModeCode\": 0,\n \"Country\": \"\",\n \"CityName\": \"\",\n \"CitySubdivisionName\": \"\",\n \"StreetName\": \"\",\n \"BuildingName\": \"\",\n \"BuildingNumber\": \"\",\n \"PostalZone\": \"\",\n \"TransportMeans\": \"\",\n \"DeclaredForCarriageValueAmount\": 0,\n \"DeliveryInsuranceValue\": 0\n },\n \"PaymentMeans\": [\n {\n \"PaymentMeansCode\": \"\",\n \"PayeeFinancialAccountID\": \"\",\n \"CurrencyCode\": \"\"\n }\n ],\n \"ReferencedDespatches\": [\n {\n \"ID\": \"\",\n \"IssueDate\": \"2026-01-15T10:30:00\"\n }\n ],\n \"CustomerIdentitySchemes\": [\n {\n \"SchemeID\": \"\",\n \"Value\": \"\"\n }\n ],\n \"PublicSectorSpendingUnit\": {\n \"BCP_Name\": \"\",\n \"BCP_VKN\": \"\",\n \"BCP_Country\": \"\",\n \"BCP_CityName\": \"\",\n \"BCP_CitySubdivisionName\": \"\"\n },\n \"SgkInfo\": {\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"MukellefKodu\": \"\",\n \"MukellefAdi\": \"\",\n \"DosyaNo\": \"\",\n \"FaturaAltTipi\": \"\"\n },\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"\",\n \"Quantity\": 0,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ],\n \"ExportInfo\": {\n \"PackagingType\": \"\",\n \"DeliveryTerm\": \"\",\n \"TransportMode\": 0,\n \"RequiredCustomsID\": \"\",\n \"DeliveryAddress_CityName\": \"\",\n \"DeliveryAddress_CitySubdivisionName\": \"\",\n \"DeliveryAddress_Country\": \"\",\n \"DeliveryAddress_StreetName\": \"\",\n \"DeliveryAddress_BuildingName\": \"\",\n \"DeliveryAddress_BuildingNumber\": \"\",\n \"DeliveryAddress_PostalCode\": \"\",\n \"TransportMeansID\": \"\",\n \"GrossWeightMeasure\": 0,\n \"NetWeightMeasure\": 0,\n \"PackageBrand\": \"\",\n \"PackageID\": \"\",\n \"PackageQuantity\": 0\n },\n \"MedicineDeviceInfo\": {\n \"Ilaclar\": [\n {\n \"GTIN\": \"\",\n \"SN\": \"\",\n \"BN\": \"\",\n \"XD\": \"2026-01-15T10:30:00\"\n }\n ],\n \"TibbiCihazlar\": [\n {\n \"UNO\": \"\",\n \"LNO\": \"\",\n \"SNO\": \"\",\n \"URT\": \"2026-01-15T10:30:00\"\n }\n ]\n },\n \"HalInfo\": {\n \"KUNYENO\": \"\",\n \"MALSAHIBIVKNTCKN\": \"\",\n \"MALSAHIBIADSOYADUNVAN\": \"\"\n },\n \"ProductInfo\": {\n \"ModelName\": \"\",\n \"BrandName\": \"\",\n \"SellersItemIdentification\": \"\",\n \"BuyersItemIdentification\": \"\",\n \"ManufacturersItemIdentification\": \"\",\n \"OriginCountryCode\": \"\",\n \"OriginCountryName\": \"\",\n \"ProductTraceID\": \"\",\n \"CommodityClassification\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/purchase-invoices", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-invoices" ], "variable": [], "query": [] }, "description": "Creates a purchase invoice with its lines, their discounts, and, for a line with a warehouse movement, its Lot/serial number entries, in one transaction. The API does not calculate or cross-check amounts: send the line amounts and the invoice totals as calculated by your system, except the withheld VAT amount, which the API calculates. The quantity of each line in the product's main unit is calculated by the API. The address, title, tax number and tax office are copied from the customer and are not accepted in the request. The invoice always creates a customer ledger entry. Send InvoiceNumber as \"Next\" to generate it automatically from the ALFATNO number series." } }, { "name": "Get purchase invoice", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/purchase-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Returns the purchase invoice with its lines, their discounts, and, for a line with a warehouse movement, its Lot/serial number entries." } }, { "name": "Update purchase invoice", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 0,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 0,\n \"VatTotal\": 0,\n \"GrandTotal\": 0,\n \"Consolidated\": false,\n \"PrintDescription\": false,\n \"Cancelled\": false,\n \"ApplyWithholding\": false,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithholdingTotal\": 0,\n \"AdditionalTaxTotal\": 0,\n \"ProfileId\": \"\",\n \"InvoiceTypeCode\": \"\",\n \"WithholdingTaxRate\": 0,\n \"SocialSecurityRate\": 0,\n \"MarketRate\": 0,\n \"ReturnedInvoiceNumber\": \"\",\n \"ReturnedInvoiceDate\": \"2026-01-15T10:30:00\",\n \"OrderReferenceNumber\": \"\",\n \"OrderReferenceDate\": \"2026-01-15T10:30:00\",\n \"BranchNumber\": \"\",\n \"BranchTitle\": \"\",\n \"BranchAddress\": \"\",\n \"InvestmentIncentiveDocumentNumber\": \"\",\n \"InvestmentIncentiveDocumentDate\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodStart\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodEnd\": \"2026-01-15T10:30:00\",\n \"DeliveryInfo\": {\n \"DeliveryTerm\": \"\",\n \"TransportModeCode\": 0,\n \"Country\": \"\",\n \"CityName\": \"\",\n \"CitySubdivisionName\": \"\",\n \"StreetName\": \"\",\n \"BuildingName\": \"\",\n \"BuildingNumber\": \"\",\n \"PostalZone\": \"\",\n \"TransportMeans\": \"\",\n \"DeclaredForCarriageValueAmount\": 0,\n \"DeliveryInsuranceValue\": 0\n },\n \"PaymentMeans\": [\n {\n \"PaymentMeansCode\": \"\",\n \"PayeeFinancialAccountID\": \"\",\n \"CurrencyCode\": \"\"\n }\n ],\n \"ReferencedDespatches\": [\n {\n \"ID\": \"\",\n \"IssueDate\": \"2026-01-15T10:30:00\"\n }\n ],\n \"CustomerIdentitySchemes\": [\n {\n \"SchemeID\": \"\",\n \"Value\": \"\"\n }\n ],\n \"PublicSectorSpendingUnit\": {\n \"BCP_Name\": \"\",\n \"BCP_VKN\": \"\",\n \"BCP_Country\": \"\",\n \"BCP_CityName\": \"\",\n \"BCP_CitySubdivisionName\": \"\"\n },\n \"SgkInfo\": {\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"MukellefKodu\": \"\",\n \"MukellefAdi\": \"\",\n \"DosyaNo\": \"\",\n \"FaturaAltTipi\": \"\"\n },\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"\",\n \"Quantity\": 0,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ],\n \"ExportInfo\": {\n \"PackagingType\": \"\",\n \"DeliveryTerm\": \"\",\n \"TransportMode\": 0,\n \"RequiredCustomsID\": \"\",\n \"DeliveryAddress_CityName\": \"\",\n \"DeliveryAddress_CitySubdivisionName\": \"\",\n \"DeliveryAddress_Country\": \"\",\n \"DeliveryAddress_StreetName\": \"\",\n \"DeliveryAddress_BuildingName\": \"\",\n \"DeliveryAddress_BuildingNumber\": \"\",\n \"DeliveryAddress_PostalCode\": \"\",\n \"TransportMeansID\": \"\",\n \"GrossWeightMeasure\": 0,\n \"NetWeightMeasure\": 0,\n \"PackageBrand\": \"\",\n \"PackageID\": \"\",\n \"PackageQuantity\": 0\n },\n \"MedicineDeviceInfo\": {\n \"Ilaclar\": [\n {\n \"GTIN\": \"\",\n \"SN\": \"\",\n \"BN\": \"\",\n \"XD\": \"2026-01-15T10:30:00\"\n }\n ],\n \"TibbiCihazlar\": [\n {\n \"UNO\": \"\",\n \"LNO\": \"\",\n \"SNO\": \"\",\n \"URT\": \"2026-01-15T10:30:00\"\n }\n ]\n },\n \"HalInfo\": {\n \"KUNYENO\": \"\",\n \"MALSAHIBIVKNTCKN\": \"\",\n \"MALSAHIBIADSOYADUNVAN\": \"\"\n },\n \"ProductInfo\": {\n \"ModelName\": \"\",\n \"BrandName\": \"\",\n \"SellersItemIdentification\": \"\",\n \"BuyersItemIdentification\": \"\",\n \"ManufacturersItemIdentification\": \"\",\n \"OriginCountryCode\": \"\",\n \"OriginCountryName\": \"\",\n \"ProductTraceID\": \"\",\n \"CommodityClassification\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/purchase-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Replaces all fields of the invoice, and replaces its lines: the order in which lines are sent determines their identity (the line at the same position as an existing line is treated as that line - its generated warehouse movement, Lot/serial number and linked-order records move with it), a shorter list removes the trailing lines, a longer list adds new ones at the end. InvoiceNumber cannot be \"Next\"." } }, { "name": "Partially update purchase invoice", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/purchase-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines (with the same line-identity rule as a full update), when it is not sent the lines stay as they are." } }, { "name": "Delete purchase invoice", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/purchase-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Deletes the invoice, its lines and the warehouse document generated for them. A Lot that has already been consumed by an outbound transaction, or a serial number that has already been dispatched, blocks the deletion of the line it belongs to. An invoice whose customer ledger entry has already been closed by a collection/payment cannot be deleted, and neither can one referenced by other records." } } ] }, { "name": "Sales Invoices", "item": [ { "name": "List sales invoices", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/sales-invoices?page=1&pageSize=50&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-invoices" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in InvoiceNumber, DocumentNumber and the customer name.", "disabled": true } ] }, "description": "Returns sales invoices page by page, newest first, without their lines. Use Get sales invoice to read the lines." } }, { "name": "Create sales invoice", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 0,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 0,\n \"VatTotal\": 0,\n \"GrandTotal\": 0,\n \"Consolidated\": false,\n \"PrintDescription\": false,\n \"Cancelled\": false,\n \"ApplyWithholding\": false,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithholdingTotal\": 0,\n \"AdditionalTaxTotal\": 0,\n \"ProfileId\": \"\",\n \"InvoiceTypeCode\": \"\",\n \"WithholdingTaxRate\": 0,\n \"SocialSecurityRate\": 0,\n \"MarketRate\": 0,\n \"ReturnedInvoiceNumber\": \"\",\n \"ReturnedInvoiceDate\": \"2026-01-15T10:30:00\",\n \"OrderReferenceNumber\": \"\",\n \"OrderReferenceDate\": \"2026-01-15T10:30:00\",\n \"BranchNumber\": \"\",\n \"BranchTitle\": \"\",\n \"BranchAddress\": \"\",\n \"InvestmentIncentiveDocumentNumber\": \"\",\n \"InvestmentIncentiveDocumentDate\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodStart\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodEnd\": \"2026-01-15T10:30:00\",\n \"DeliveryInfo\": {\n \"DeliveryTerm\": \"\",\n \"TransportModeCode\": 0,\n \"Country\": \"\",\n \"CityName\": \"\",\n \"CitySubdivisionName\": \"\",\n \"StreetName\": \"\",\n \"BuildingName\": \"\",\n \"BuildingNumber\": \"\",\n \"PostalZone\": \"\",\n \"TransportMeans\": \"\",\n \"DeclaredForCarriageValueAmount\": 0,\n \"DeliveryInsuranceValue\": 0\n },\n \"PaymentMeans\": [\n {\n \"PaymentMeansCode\": \"\",\n \"PayeeFinancialAccountID\": \"\",\n \"CurrencyCode\": \"\"\n }\n ],\n \"ReferencedDespatches\": [\n {\n \"ID\": \"\",\n \"IssueDate\": \"2026-01-15T10:30:00\"\n }\n ],\n \"CustomerIdentitySchemes\": [\n {\n \"SchemeID\": \"\",\n \"Value\": \"\"\n }\n ],\n \"PublicSectorSpendingUnit\": {\n \"BCP_Name\": \"\",\n \"BCP_VKN\": \"\",\n \"BCP_Country\": \"\",\n \"BCP_CityName\": \"\",\n \"BCP_CitySubdivisionName\": \"\"\n },\n \"SgkInfo\": {\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"MukellefKodu\": \"\",\n \"MukellefAdi\": \"\",\n \"DosyaNo\": \"\",\n \"FaturaAltTipi\": \"\"\n },\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"\",\n \"Quantity\": 0,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ],\n \"ExportInfo\": {\n \"PackagingType\": \"\",\n \"DeliveryTerm\": \"\",\n \"TransportMode\": 0,\n \"RequiredCustomsID\": \"\",\n \"DeliveryAddress_CityName\": \"\",\n \"DeliveryAddress_CitySubdivisionName\": \"\",\n \"DeliveryAddress_Country\": \"\",\n \"DeliveryAddress_StreetName\": \"\",\n \"DeliveryAddress_BuildingName\": \"\",\n \"DeliveryAddress_BuildingNumber\": \"\",\n \"DeliveryAddress_PostalCode\": \"\",\n \"TransportMeansID\": \"\",\n \"GrossWeightMeasure\": 0,\n \"NetWeightMeasure\": 0,\n \"PackageBrand\": \"\",\n \"PackageID\": \"\",\n \"PackageQuantity\": 0\n },\n \"MedicineDeviceInfo\": {\n \"Ilaclar\": [\n {\n \"GTIN\": \"\",\n \"SN\": \"\",\n \"BN\": \"\",\n \"XD\": \"2026-01-15T10:30:00\"\n }\n ],\n \"TibbiCihazlar\": [\n {\n \"UNO\": \"\",\n \"LNO\": \"\",\n \"SNO\": \"\",\n \"URT\": \"2026-01-15T10:30:00\"\n }\n ]\n },\n \"HalInfo\": {\n \"KUNYENO\": \"\",\n \"MALSAHIBIVKNTCKN\": \"\",\n \"MALSAHIBIADSOYADUNVAN\": \"\"\n },\n \"ProductInfo\": {\n \"ModelName\": \"\",\n \"BrandName\": \"\",\n \"SellersItemIdentification\": \"\",\n \"BuyersItemIdentification\": \"\",\n \"ManufacturersItemIdentification\": \"\",\n \"OriginCountryCode\": \"\",\n \"OriginCountryName\": \"\",\n \"ProductTraceID\": \"\",\n \"CommodityClassification\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sales-invoices", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-invoices" ], "variable": [], "query": [] }, "description": "Creates a sales invoice with its lines, their discounts, and, for a line with a warehouse movement, its Lot/serial number entries, in one transaction. The API does not calculate or cross-check amounts: send the line amounts and the invoice totals as calculated by your system, except the withheld VAT amount, which the API calculates. The quantity of each line in the product's main unit is calculated by the API. The address, title, tax number and tax office are copied from the customer and are not accepted in the request. The invoice always creates a customer ledger entry. Send InvoiceNumber as \"Next\" to generate it automatically: from the SATFATNO number series when EInvoiceType is 0, otherwise from the e-Invoice numbering." } }, { "name": "Get sales invoice", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/sales-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Returns the sales invoice with its lines, their discounts, and, for a line with a warehouse movement, its Lot/serial number entries." } }, { "name": "Update sales invoice", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 0,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 0,\n \"VatTotal\": 0,\n \"GrandTotal\": 0,\n \"Consolidated\": false,\n \"PrintDescription\": false,\n \"Cancelled\": false,\n \"ApplyWithholding\": false,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithholdingTotal\": 0,\n \"AdditionalTaxTotal\": 0,\n \"ProfileId\": \"\",\n \"InvoiceTypeCode\": \"\",\n \"WithholdingTaxRate\": 0,\n \"SocialSecurityRate\": 0,\n \"MarketRate\": 0,\n \"ReturnedInvoiceNumber\": \"\",\n \"ReturnedInvoiceDate\": \"2026-01-15T10:30:00\",\n \"OrderReferenceNumber\": \"\",\n \"OrderReferenceDate\": \"2026-01-15T10:30:00\",\n \"BranchNumber\": \"\",\n \"BranchTitle\": \"\",\n \"BranchAddress\": \"\",\n \"InvestmentIncentiveDocumentNumber\": \"\",\n \"InvestmentIncentiveDocumentDate\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodStart\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodEnd\": \"2026-01-15T10:30:00\",\n \"DeliveryInfo\": {\n \"DeliveryTerm\": \"\",\n \"TransportModeCode\": 0,\n \"Country\": \"\",\n \"CityName\": \"\",\n \"CitySubdivisionName\": \"\",\n \"StreetName\": \"\",\n \"BuildingName\": \"\",\n \"BuildingNumber\": \"\",\n \"PostalZone\": \"\",\n \"TransportMeans\": \"\",\n \"DeclaredForCarriageValueAmount\": 0,\n \"DeliveryInsuranceValue\": 0\n },\n \"PaymentMeans\": [\n {\n \"PaymentMeansCode\": \"\",\n \"PayeeFinancialAccountID\": \"\",\n \"CurrencyCode\": \"\"\n }\n ],\n \"ReferencedDespatches\": [\n {\n \"ID\": \"\",\n \"IssueDate\": \"2026-01-15T10:30:00\"\n }\n ],\n \"CustomerIdentitySchemes\": [\n {\n \"SchemeID\": \"\",\n \"Value\": \"\"\n }\n ],\n \"PublicSectorSpendingUnit\": {\n \"BCP_Name\": \"\",\n \"BCP_VKN\": \"\",\n \"BCP_Country\": \"\",\n \"BCP_CityName\": \"\",\n \"BCP_CitySubdivisionName\": \"\"\n },\n \"SgkInfo\": {\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"MukellefKodu\": \"\",\n \"MukellefAdi\": \"\",\n \"DosyaNo\": \"\",\n \"FaturaAltTipi\": \"\"\n },\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"\",\n \"Quantity\": 0,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ],\n \"ExportInfo\": {\n \"PackagingType\": \"\",\n \"DeliveryTerm\": \"\",\n \"TransportMode\": 0,\n \"RequiredCustomsID\": \"\",\n \"DeliveryAddress_CityName\": \"\",\n \"DeliveryAddress_CitySubdivisionName\": \"\",\n \"DeliveryAddress_Country\": \"\",\n \"DeliveryAddress_StreetName\": \"\",\n \"DeliveryAddress_BuildingName\": \"\",\n \"DeliveryAddress_BuildingNumber\": \"\",\n \"DeliveryAddress_PostalCode\": \"\",\n \"TransportMeansID\": \"\",\n \"GrossWeightMeasure\": 0,\n \"NetWeightMeasure\": 0,\n \"PackageBrand\": \"\",\n \"PackageID\": \"\",\n \"PackageQuantity\": 0\n },\n \"MedicineDeviceInfo\": {\n \"Ilaclar\": [\n {\n \"GTIN\": \"\",\n \"SN\": \"\",\n \"BN\": \"\",\n \"XD\": \"2026-01-15T10:30:00\"\n }\n ],\n \"TibbiCihazlar\": [\n {\n \"UNO\": \"\",\n \"LNO\": \"\",\n \"SNO\": \"\",\n \"URT\": \"2026-01-15T10:30:00\"\n }\n ]\n },\n \"HalInfo\": {\n \"KUNYENO\": \"\",\n \"MALSAHIBIVKNTCKN\": \"\",\n \"MALSAHIBIADSOYADUNVAN\": \"\"\n },\n \"ProductInfo\": {\n \"ModelName\": \"\",\n \"BrandName\": \"\",\n \"SellersItemIdentification\": \"\",\n \"BuyersItemIdentification\": \"\",\n \"ManufacturersItemIdentification\": \"\",\n \"OriginCountryCode\": \"\",\n \"OriginCountryName\": \"\",\n \"ProductTraceID\": \"\",\n \"CommodityClassification\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sales-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Replaces all fields of the invoice, and replaces its lines: the order in which lines are sent determines their identity (the line at the same position as an existing line is treated as that line - its generated warehouse movement, Lot/serial number and linked-order records move with it), a shorter list removes the trailing lines, a longer list adds new ones at the end. InvoiceNumber cannot be \"Next\"." } }, { "name": "Partially update sales invoice", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sales-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines (with the same line-identity rule as a full update), when it is not sent the lines stay as they are." } }, { "name": "Delete sales invoice", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/sales-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Deletes the invoice, its lines and the warehouse document generated for them. A Lot that has already been consumed by an outbound transaction, or a serial number that has already been dispatched, blocks the deletion of the line it belongs to. An invoice whose customer ledger entry has already been closed by a collection/payment cannot be deleted, and neither can one referenced by other records." } } ] }, { "name": "Purchase Return Invoices", "item": [ { "name": "List purchase return invoices", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/purchase-return-invoices?page=1&pageSize=50&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-return-invoices" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in InvoiceNumber, DocumentNumber and the customer name.", "disabled": true } ] }, "description": "Returns purchase return invoices page by page, newest first, without their lines. Use Get purchase return invoice to read the lines." } }, { "name": "Create purchase return invoice", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 0,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 0,\n \"VatTotal\": 0,\n \"GrandTotal\": 0,\n \"Consolidated\": false,\n \"PrintDescription\": false,\n \"Cancelled\": false,\n \"ApplyWithholding\": false,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithholdingTotal\": 0,\n \"AdditionalTaxTotal\": 0,\n \"ProfileId\": \"\",\n \"InvoiceTypeCode\": \"\",\n \"WithholdingTaxRate\": 0,\n \"SocialSecurityRate\": 0,\n \"MarketRate\": 0,\n \"ReturnedInvoiceNumber\": \"\",\n \"ReturnedInvoiceDate\": \"2026-01-15T10:30:00\",\n \"OrderReferenceNumber\": \"\",\n \"OrderReferenceDate\": \"2026-01-15T10:30:00\",\n \"BranchNumber\": \"\",\n \"BranchTitle\": \"\",\n \"BranchAddress\": \"\",\n \"InvestmentIncentiveDocumentNumber\": \"\",\n \"InvestmentIncentiveDocumentDate\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodStart\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodEnd\": \"2026-01-15T10:30:00\",\n \"DeliveryInfo\": {\n \"DeliveryTerm\": \"\",\n \"TransportModeCode\": 0,\n \"Country\": \"\",\n \"CityName\": \"\",\n \"CitySubdivisionName\": \"\",\n \"StreetName\": \"\",\n \"BuildingName\": \"\",\n \"BuildingNumber\": \"\",\n \"PostalZone\": \"\",\n \"TransportMeans\": \"\",\n \"DeclaredForCarriageValueAmount\": 0,\n \"DeliveryInsuranceValue\": 0\n },\n \"PaymentMeans\": [\n {\n \"PaymentMeansCode\": \"\",\n \"PayeeFinancialAccountID\": \"\",\n \"CurrencyCode\": \"\"\n }\n ],\n \"ReferencedDespatches\": [\n {\n \"ID\": \"\",\n \"IssueDate\": \"2026-01-15T10:30:00\"\n }\n ],\n \"CustomerIdentitySchemes\": [\n {\n \"SchemeID\": \"\",\n \"Value\": \"\"\n }\n ],\n \"PublicSectorSpendingUnit\": {\n \"BCP_Name\": \"\",\n \"BCP_VKN\": \"\",\n \"BCP_Country\": \"\",\n \"BCP_CityName\": \"\",\n \"BCP_CitySubdivisionName\": \"\"\n },\n \"SgkInfo\": {\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"MukellefKodu\": \"\",\n \"MukellefAdi\": \"\",\n \"DosyaNo\": \"\",\n \"FaturaAltTipi\": \"\"\n },\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"\",\n \"Quantity\": 0,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ],\n \"ExportInfo\": {\n \"PackagingType\": \"\",\n \"DeliveryTerm\": \"\",\n \"TransportMode\": 0,\n \"RequiredCustomsID\": \"\",\n \"DeliveryAddress_CityName\": \"\",\n \"DeliveryAddress_CitySubdivisionName\": \"\",\n \"DeliveryAddress_Country\": \"\",\n \"DeliveryAddress_StreetName\": \"\",\n \"DeliveryAddress_BuildingName\": \"\",\n \"DeliveryAddress_BuildingNumber\": \"\",\n \"DeliveryAddress_PostalCode\": \"\",\n \"TransportMeansID\": \"\",\n \"GrossWeightMeasure\": 0,\n \"NetWeightMeasure\": 0,\n \"PackageBrand\": \"\",\n \"PackageID\": \"\",\n \"PackageQuantity\": 0\n },\n \"MedicineDeviceInfo\": {\n \"Ilaclar\": [\n {\n \"GTIN\": \"\",\n \"SN\": \"\",\n \"BN\": \"\",\n \"XD\": \"2026-01-15T10:30:00\"\n }\n ],\n \"TibbiCihazlar\": [\n {\n \"UNO\": \"\",\n \"LNO\": \"\",\n \"SNO\": \"\",\n \"URT\": \"2026-01-15T10:30:00\"\n }\n ]\n },\n \"HalInfo\": {\n \"KUNYENO\": \"\",\n \"MALSAHIBIVKNTCKN\": \"\",\n \"MALSAHIBIADSOYADUNVAN\": \"\"\n },\n \"ProductInfo\": {\n \"ModelName\": \"\",\n \"BrandName\": \"\",\n \"SellersItemIdentification\": \"\",\n \"BuyersItemIdentification\": \"\",\n \"ManufacturersItemIdentification\": \"\",\n \"OriginCountryCode\": \"\",\n \"OriginCountryName\": \"\",\n \"ProductTraceID\": \"\",\n \"CommodityClassification\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/purchase-return-invoices", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-return-invoices" ], "variable": [], "query": [] }, "description": "Creates a purchase return invoice with its lines, their discounts, and, for a line with a warehouse movement, its Lot/serial number entries, in one transaction. The API does not calculate or cross-check amounts: send the line amounts and the invoice totals as calculated by your system, except the withheld VAT amount, which the API calculates. The quantity of each line in the product's main unit is calculated by the API. The address, title, tax number and tax office are copied from the customer and are not accepted in the request. The invoice always creates a customer ledger entry. This invoice type has no plain number series: send InvoiceNumber as \"Next\" with EInvoiceType 1 (e-Invoice) or 2 (e-Archive) to generate it from the e-Invoice numbering, or send a manual number." } }, { "name": "Get purchase return invoice", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/purchase-return-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-return-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Returns the purchase return invoice with its lines, their discounts, and, for a line with a warehouse movement, its Lot/serial number entries." } }, { "name": "Update purchase return invoice", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 0,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 0,\n \"VatTotal\": 0,\n \"GrandTotal\": 0,\n \"Consolidated\": false,\n \"PrintDescription\": false,\n \"Cancelled\": false,\n \"ApplyWithholding\": false,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithholdingTotal\": 0,\n \"AdditionalTaxTotal\": 0,\n \"ProfileId\": \"\",\n \"InvoiceTypeCode\": \"\",\n \"WithholdingTaxRate\": 0,\n \"SocialSecurityRate\": 0,\n \"MarketRate\": 0,\n \"ReturnedInvoiceNumber\": \"\",\n \"ReturnedInvoiceDate\": \"2026-01-15T10:30:00\",\n \"OrderReferenceNumber\": \"\",\n \"OrderReferenceDate\": \"2026-01-15T10:30:00\",\n \"BranchNumber\": \"\",\n \"BranchTitle\": \"\",\n \"BranchAddress\": \"\",\n \"InvestmentIncentiveDocumentNumber\": \"\",\n \"InvestmentIncentiveDocumentDate\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodStart\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodEnd\": \"2026-01-15T10:30:00\",\n \"DeliveryInfo\": {\n \"DeliveryTerm\": \"\",\n \"TransportModeCode\": 0,\n \"Country\": \"\",\n \"CityName\": \"\",\n \"CitySubdivisionName\": \"\",\n \"StreetName\": \"\",\n \"BuildingName\": \"\",\n \"BuildingNumber\": \"\",\n \"PostalZone\": \"\",\n \"TransportMeans\": \"\",\n \"DeclaredForCarriageValueAmount\": 0,\n \"DeliveryInsuranceValue\": 0\n },\n \"PaymentMeans\": [\n {\n \"PaymentMeansCode\": \"\",\n \"PayeeFinancialAccountID\": \"\",\n \"CurrencyCode\": \"\"\n }\n ],\n \"ReferencedDespatches\": [\n {\n \"ID\": \"\",\n \"IssueDate\": \"2026-01-15T10:30:00\"\n }\n ],\n \"CustomerIdentitySchemes\": [\n {\n \"SchemeID\": \"\",\n \"Value\": \"\"\n }\n ],\n \"PublicSectorSpendingUnit\": {\n \"BCP_Name\": \"\",\n \"BCP_VKN\": \"\",\n \"BCP_Country\": \"\",\n \"BCP_CityName\": \"\",\n \"BCP_CitySubdivisionName\": \"\"\n },\n \"SgkInfo\": {\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"MukellefKodu\": \"\",\n \"MukellefAdi\": \"\",\n \"DosyaNo\": \"\",\n \"FaturaAltTipi\": \"\"\n },\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"\",\n \"Quantity\": 0,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ],\n \"ExportInfo\": {\n \"PackagingType\": \"\",\n \"DeliveryTerm\": \"\",\n \"TransportMode\": 0,\n \"RequiredCustomsID\": \"\",\n \"DeliveryAddress_CityName\": \"\",\n \"DeliveryAddress_CitySubdivisionName\": \"\",\n \"DeliveryAddress_Country\": \"\",\n \"DeliveryAddress_StreetName\": \"\",\n \"DeliveryAddress_BuildingName\": \"\",\n \"DeliveryAddress_BuildingNumber\": \"\",\n \"DeliveryAddress_PostalCode\": \"\",\n \"TransportMeansID\": \"\",\n \"GrossWeightMeasure\": 0,\n \"NetWeightMeasure\": 0,\n \"PackageBrand\": \"\",\n \"PackageID\": \"\",\n \"PackageQuantity\": 0\n },\n \"MedicineDeviceInfo\": {\n \"Ilaclar\": [\n {\n \"GTIN\": \"\",\n \"SN\": \"\",\n \"BN\": \"\",\n \"XD\": \"2026-01-15T10:30:00\"\n }\n ],\n \"TibbiCihazlar\": [\n {\n \"UNO\": \"\",\n \"LNO\": \"\",\n \"SNO\": \"\",\n \"URT\": \"2026-01-15T10:30:00\"\n }\n ]\n },\n \"HalInfo\": {\n \"KUNYENO\": \"\",\n \"MALSAHIBIVKNTCKN\": \"\",\n \"MALSAHIBIADSOYADUNVAN\": \"\"\n },\n \"ProductInfo\": {\n \"ModelName\": \"\",\n \"BrandName\": \"\",\n \"SellersItemIdentification\": \"\",\n \"BuyersItemIdentification\": \"\",\n \"ManufacturersItemIdentification\": \"\",\n \"OriginCountryCode\": \"\",\n \"OriginCountryName\": \"\",\n \"ProductTraceID\": \"\",\n \"CommodityClassification\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/purchase-return-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-return-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Replaces all fields of the invoice, and replaces its lines: the order in which lines are sent determines their identity (the line at the same position as an existing line is treated as that line - its generated warehouse movement, Lot/serial number and linked-order records move with it), a shorter list removes the trailing lines, a longer list adds new ones at the end. InvoiceNumber cannot be \"Next\"." } }, { "name": "Partially update purchase return invoice", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/purchase-return-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-return-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines (with the same line-identity rule as a full update), when it is not sent the lines stay as they are." } }, { "name": "Delete purchase return invoice", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/purchase-return-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "purchase-return-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Deletes the invoice, its lines and the warehouse document generated for them. A Lot that has already been consumed by an outbound transaction, or a serial number that has already been dispatched, blocks the deletion of the line it belongs to. An invoice whose customer ledger entry has already been closed by a collection/payment cannot be deleted, and neither can one referenced by other records." } } ] }, { "name": "Sales Return Invoices", "item": [ { "name": "List sales return invoices", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/sales-return-invoices?page=1&pageSize=50&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-return-invoices" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in InvoiceNumber, DocumentNumber and the customer name.", "disabled": true } ] }, "description": "Returns sales return invoices page by page, newest first, without their lines. Use Get sales return invoice to read the lines." } }, { "name": "Create sales return invoice", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 0,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 0,\n \"VatTotal\": 0,\n \"GrandTotal\": 0,\n \"Consolidated\": false,\n \"PrintDescription\": false,\n \"Cancelled\": false,\n \"ApplyWithholding\": false,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithholdingTotal\": 0,\n \"AdditionalTaxTotal\": 0,\n \"ProfileId\": \"\",\n \"InvoiceTypeCode\": \"\",\n \"WithholdingTaxRate\": 0,\n \"SocialSecurityRate\": 0,\n \"MarketRate\": 0,\n \"ReturnedInvoiceNumber\": \"\",\n \"ReturnedInvoiceDate\": \"2026-01-15T10:30:00\",\n \"OrderReferenceNumber\": \"\",\n \"OrderReferenceDate\": \"2026-01-15T10:30:00\",\n \"BranchNumber\": \"\",\n \"BranchTitle\": \"\",\n \"BranchAddress\": \"\",\n \"InvestmentIncentiveDocumentNumber\": \"\",\n \"InvestmentIncentiveDocumentDate\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodStart\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodEnd\": \"2026-01-15T10:30:00\",\n \"DeliveryInfo\": {\n \"DeliveryTerm\": \"\",\n \"TransportModeCode\": 0,\n \"Country\": \"\",\n \"CityName\": \"\",\n \"CitySubdivisionName\": \"\",\n \"StreetName\": \"\",\n \"BuildingName\": \"\",\n \"BuildingNumber\": \"\",\n \"PostalZone\": \"\",\n \"TransportMeans\": \"\",\n \"DeclaredForCarriageValueAmount\": 0,\n \"DeliveryInsuranceValue\": 0\n },\n \"PaymentMeans\": [\n {\n \"PaymentMeansCode\": \"\",\n \"PayeeFinancialAccountID\": \"\",\n \"CurrencyCode\": \"\"\n }\n ],\n \"ReferencedDespatches\": [\n {\n \"ID\": \"\",\n \"IssueDate\": \"2026-01-15T10:30:00\"\n }\n ],\n \"CustomerIdentitySchemes\": [\n {\n \"SchemeID\": \"\",\n \"Value\": \"\"\n }\n ],\n \"PublicSectorSpendingUnit\": {\n \"BCP_Name\": \"\",\n \"BCP_VKN\": \"\",\n \"BCP_Country\": \"\",\n \"BCP_CityName\": \"\",\n \"BCP_CitySubdivisionName\": \"\"\n },\n \"SgkInfo\": {\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"MukellefKodu\": \"\",\n \"MukellefAdi\": \"\",\n \"DosyaNo\": \"\",\n \"FaturaAltTipi\": \"\"\n },\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"\",\n \"Quantity\": 0,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ],\n \"ExportInfo\": {\n \"PackagingType\": \"\",\n \"DeliveryTerm\": \"\",\n \"TransportMode\": 0,\n \"RequiredCustomsID\": \"\",\n \"DeliveryAddress_CityName\": \"\",\n \"DeliveryAddress_CitySubdivisionName\": \"\",\n \"DeliveryAddress_Country\": \"\",\n \"DeliveryAddress_StreetName\": \"\",\n \"DeliveryAddress_BuildingName\": \"\",\n \"DeliveryAddress_BuildingNumber\": \"\",\n \"DeliveryAddress_PostalCode\": \"\",\n \"TransportMeansID\": \"\",\n \"GrossWeightMeasure\": 0,\n \"NetWeightMeasure\": 0,\n \"PackageBrand\": \"\",\n \"PackageID\": \"\",\n \"PackageQuantity\": 0\n },\n \"MedicineDeviceInfo\": {\n \"Ilaclar\": [\n {\n \"GTIN\": \"\",\n \"SN\": \"\",\n \"BN\": \"\",\n \"XD\": \"2026-01-15T10:30:00\"\n }\n ],\n \"TibbiCihazlar\": [\n {\n \"UNO\": \"\",\n \"LNO\": \"\",\n \"SNO\": \"\",\n \"URT\": \"2026-01-15T10:30:00\"\n }\n ]\n },\n \"HalInfo\": {\n \"KUNYENO\": \"\",\n \"MALSAHIBIVKNTCKN\": \"\",\n \"MALSAHIBIADSOYADUNVAN\": \"\"\n },\n \"ProductInfo\": {\n \"ModelName\": \"\",\n \"BrandName\": \"\",\n \"SellersItemIdentification\": \"\",\n \"BuyersItemIdentification\": \"\",\n \"ManufacturersItemIdentification\": \"\",\n \"OriginCountryCode\": \"\",\n \"OriginCountryName\": \"\",\n \"ProductTraceID\": \"\",\n \"CommodityClassification\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sales-return-invoices", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-return-invoices" ], "variable": [], "query": [] }, "description": "Creates a sales return invoice with its lines, their discounts, and, for a line with a warehouse movement, its Lot/serial number entries, in one transaction. The API does not calculate or cross-check amounts: send the line amounts and the invoice totals as calculated by your system, except the withheld VAT amount, which the API calculates. The quantity of each line in the product's main unit is calculated by the API. The address, title, tax number and tax office are copied from the customer and are not accepted in the request. The invoice always creates a customer ledger entry. Send InvoiceNumber as \"Next\" to generate it automatically from the SATİADEFATNO number series." } }, { "name": "Get sales return invoice", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/sales-return-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-return-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Returns the sales return invoice with its lines, their discounts, and, for a line with a warehouse movement, its Lot/serial number entries." } }, { "name": "Update sales return invoice", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\",\n \"Date\": \"2026-09-21T10:30:00\",\n \"Description\": \"\",\n \"CustomerCode\": \"C-0001\",\n \"DueDays\": 0,\n \"SharingCode\": \"\",\n \"ShipmentDefinitionCode\": \"\",\n \"DiscountTotal\": 0,\n \"SubTotal\": 0,\n \"VatTotal\": 0,\n \"GrandTotal\": 0,\n \"Consolidated\": false,\n \"PrintDescription\": false,\n \"Cancelled\": false,\n \"ApplyWithholding\": false,\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithholdingTotal\": 0,\n \"AdditionalTaxTotal\": 0,\n \"ProfileId\": \"\",\n \"InvoiceTypeCode\": \"\",\n \"WithholdingTaxRate\": 0,\n \"SocialSecurityRate\": 0,\n \"MarketRate\": 0,\n \"ReturnedInvoiceNumber\": \"\",\n \"ReturnedInvoiceDate\": \"2026-01-15T10:30:00\",\n \"OrderReferenceNumber\": \"\",\n \"OrderReferenceDate\": \"2026-01-15T10:30:00\",\n \"BranchNumber\": \"\",\n \"BranchTitle\": \"\",\n \"BranchAddress\": \"\",\n \"InvestmentIncentiveDocumentNumber\": \"\",\n \"InvestmentIncentiveDocumentDate\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodStart\": \"2026-01-15T10:30:00\",\n \"EnergyPeriodEnd\": \"2026-01-15T10:30:00\",\n \"DeliveryInfo\": {\n \"DeliveryTerm\": \"\",\n \"TransportModeCode\": 0,\n \"Country\": \"\",\n \"CityName\": \"\",\n \"CitySubdivisionName\": \"\",\n \"StreetName\": \"\",\n \"BuildingName\": \"\",\n \"BuildingNumber\": \"\",\n \"PostalZone\": \"\",\n \"TransportMeans\": \"\",\n \"DeclaredForCarriageValueAmount\": 0,\n \"DeliveryInsuranceValue\": 0\n },\n \"PaymentMeans\": [\n {\n \"PaymentMeansCode\": \"\",\n \"PayeeFinancialAccountID\": \"\",\n \"CurrencyCode\": \"\"\n }\n ],\n \"ReferencedDespatches\": [\n {\n \"ID\": \"\",\n \"IssueDate\": \"2026-01-15T10:30:00\"\n }\n ],\n \"CustomerIdentitySchemes\": [\n {\n \"SchemeID\": \"\",\n \"Value\": \"\"\n }\n ],\n \"PublicSectorSpendingUnit\": {\n \"BCP_Name\": \"\",\n \"BCP_VKN\": \"\",\n \"BCP_Country\": \"\",\n \"BCP_CityName\": \"\",\n \"BCP_CitySubdivisionName\": \"\"\n },\n \"SgkInfo\": {\n \"StartDate\": \"2026-01-15T10:30:00\",\n \"EndDate\": \"2026-01-15T10:30:00\",\n \"MukellefKodu\": \"\",\n \"MukellefAdi\": \"\",\n \"DosyaNo\": \"\",\n \"FaturaAltTipi\": \"\"\n },\n \"Lines\": [\n {\n \"ProductCode\": \"URN-0001\",\n \"UnitCode\": \"C62\",\n \"Quantity\": 10,\n \"UnitPrice\": 100,\n \"CurrencyCode\": \"TRY\",\n \"ExchangeRate\": 1,\n \"DiscountRate\": 0,\n \"DiscountAmount\": 0,\n \"Discounts\": [\n {\n \"Rate\": 10\n }\n ],\n \"VatRate\": 20,\n \"VatIncluded\": false,\n \"VatAmount\": 0,\n \"AmountExcludingTax\": 0,\n \"AmountIncludingTax\": 0,\n \"VatBase\": 0,\n \"VatExemptionCode\": \"\",\n \"LineGroupName\": \"\",\n \"WarehouseName\": \"Main Warehouse\",\n \"Description\": \"\",\n \"Description2\": \"\",\n \"WithholdingCode\": \"\",\n \"WithholdingNumerator\": 0,\n \"WithholdingDenominator\": 0,\n \"WithheldVatAmount\": 0,\n \"AdditionalTaxCode1\": \"\",\n \"AdditionalTaxRate1\": 0,\n \"AdditionalTaxAmount1\": 0,\n \"AdditionalTaxBase1\": 0,\n \"AdditionalTaxCode2\": \"\",\n \"AdditionalTaxRate2\": 0,\n \"AdditionalTaxAmount2\": 0,\n \"AdditionalTaxBase2\": 0,\n \"AdditionalTaxCode3\": \"\",\n \"AdditionalTaxRate3\": 0,\n \"AdditionalTaxAmount3\": 0,\n \"AdditionalTaxBase3\": 0,\n \"Lots\": [\n {\n \"LotNo\": \"\",\n \"Quantity\": 0,\n \"UnitCode\": \"C62\",\n \"SupplierLotNo\": \"\",\n \"ExpiryDate\": \"2026-01-15T10:30:00\",\n \"Description\": \"\"\n }\n ],\n \"SerialNumbers\": [\n \"\"\n ],\n \"ExportInfo\": {\n \"PackagingType\": \"\",\n \"DeliveryTerm\": \"\",\n \"TransportMode\": 0,\n \"RequiredCustomsID\": \"\",\n \"DeliveryAddress_CityName\": \"\",\n \"DeliveryAddress_CitySubdivisionName\": \"\",\n \"DeliveryAddress_Country\": \"\",\n \"DeliveryAddress_StreetName\": \"\",\n \"DeliveryAddress_BuildingName\": \"\",\n \"DeliveryAddress_BuildingNumber\": \"\",\n \"DeliveryAddress_PostalCode\": \"\",\n \"TransportMeansID\": \"\",\n \"GrossWeightMeasure\": 0,\n \"NetWeightMeasure\": 0,\n \"PackageBrand\": \"\",\n \"PackageID\": \"\",\n \"PackageQuantity\": 0\n },\n \"MedicineDeviceInfo\": {\n \"Ilaclar\": [\n {\n \"GTIN\": \"\",\n \"SN\": \"\",\n \"BN\": \"\",\n \"XD\": \"2026-01-15T10:30:00\"\n }\n ],\n \"TibbiCihazlar\": [\n {\n \"UNO\": \"\",\n \"LNO\": \"\",\n \"SNO\": \"\",\n \"URT\": \"2026-01-15T10:30:00\"\n }\n ]\n },\n \"HalInfo\": {\n \"KUNYENO\": \"\",\n \"MALSAHIBIVKNTCKN\": \"\",\n \"MALSAHIBIADSOYADUNVAN\": \"\"\n },\n \"ProductInfo\": {\n \"ModelName\": \"\",\n \"BrandName\": \"\",\n \"SellersItemIdentification\": \"\",\n \"BuyersItemIdentification\": \"\",\n \"ManufacturersItemIdentification\": \"\",\n \"OriginCountryCode\": \"\",\n \"OriginCountryName\": \"\",\n \"ProductTraceID\": \"\",\n \"CommodityClassification\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sales-return-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-return-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Replaces all fields of the invoice, and replaces its lines: the order in which lines are sent determines their identity (the line at the same position as an existing line is treated as that line - its generated warehouse movement, Lot/serial number and linked-order records move with it), a shorter list removes the trailing lines, a longer list adds new ones at the end. InvoiceNumber cannot be \"Next\"." } }, { "name": "Partially update sales return invoice", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InvoiceNumber\": \"9446A4D834\",\n \"DocumentNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/sales-return-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-return-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines (with the same line-identity rule as a full update), when it is not sent the lines stay as they are." } }, { "name": "Delete sales return invoice", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/sales-return-invoices/:invoiceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sales-return-invoices", ":invoiceId" ], "variable": [ { "key": "invoiceId", "value": "", "description": "Invoice ID." } ], "query": [] }, "description": "Deletes the invoice, its lines and the warehouse document generated for them. A Lot that has already been consumed by an outbound transaction, or a serial number that has already been dispatched, blocks the deletion of the line it belongs to. An invoice whose customer ledger entry has already been closed by a collection/payment cannot be deleted, and neither can one referenced by other records." } } ] } ] }, { "name": "Finance", "item": [ { "name": "Customer Transactions", "item": [ { "name": "Get customer transactions", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/customers/:customerId/transactions?startDate=&endDate=¤cyCode=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "customers", ":customerId", "transactions" ], "variable": [ { "key": "customerId", "value": "", "description": "Customer ID." } ], "query": [ { "key": "startDate", "value": "", "description": "Required. Start of the date range (inclusive).", "disabled": true }, { "key": "endDate", "value": "", "description": "Required. End of the date range (inclusive). Cannot be before StartDate.", "disabled": true }, { "key": "currencyCode", "value": "", "description": "Only include lines in this currency (currency code from GET /api/v1/definitions/currencies, for example TRY). When empty, all currencies are included.", "disabled": true } ] }, "description": "Returns the customer's ledger lines between StartDate and EndDate (inclusive), ordered by document date, with a running balance per line. Read-only report; nothing here can be created, updated or deleted through the API." } } ] }, { "name": "Customer Balances", "item": [ { "name": "List customer balances", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/customers/balances?page=1&pageSize=50&asOfDate=&excludeZeroBalance=false&minAbsoluteBalance=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "customers", "balances" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. Defaults to 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Items per page, up to 50. Defaults to 50.", "disabled": false }, { "key": "asOfDate", "value": "", "description": "Only movements strictly before this date and time are included (e.g. sending the 25th excludes the 25th itself as well as later dates). ISO 8601, for example 2026-09-25T14:30:00. Defaults to the current date and time when omitted.", "disabled": true }, { "key": "excludeZeroBalance", "value": "false", "description": "When true, currencies whose balance is exactly 0 are left out of Balances; a customer whose every currency nets to 0 is left out entirely. Defaults to false.", "disabled": false }, { "key": "minAbsoluteBalance", "value": "", "description": "When set, currencies whose balance's absolute value is less than or equal to this are left out of Balances (e.g. 100 excludes everything from -100 to 100 inclusive); a customer whose every currency is filtered out this way is left out entirely. Can be combined with excludeZeroBalance. Omit for no threshold.", "disabled": true } ] }, "description": "Returns every customer with at least one ledger movement before AsOfDate, with their balance per currency (sum of Debit minus sum of Credit). Read-only report; nothing here can be created, updated or deleted through the API." } } ] }, { "name": "Banks", "item": [ { "name": "List banks", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/banks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "banks" ], "variable": [], "query": [] }, "description": "Returns the banks of the company. Use a bank's Name as BankName for bank accounts." } }, { "name": "Create bank", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"İŞ BANKASI\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/banks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "banks" ], "variable": [], "query": [] }, "description": "Adds a bank. Name must be unique within the company." } }, { "name": "Get bank", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/banks/:bankId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "banks", ":bankId" ], "variable": [ { "key": "bankId", "value": "", "description": "Bank ID." } ], "query": [] } } }, { "name": "Update bank", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"İŞ BANKASI\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/banks/:bankId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "banks", ":bankId" ], "variable": [ { "key": "bankId", "value": "", "description": "Bank ID." } ], "query": [] }, "description": "Replaces all fields of the bank." } }, { "name": "Partially update bank", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"İŞ BANKASI\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/banks/:bankId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "banks", ":bankId" ], "variable": [ { "key": "bankId", "value": "", "description": "Bank ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete bank", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/banks/:bankId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "banks", ":bankId" ], "variable": [ { "key": "bankId", "value": "", "description": "Bank ID." } ], "query": [] }, "description": "Deletes the bank. A bank used by a bank account cannot be deleted." } } ] }, { "name": "Bank Accounts", "item": [ { "name": "List bank accounts", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts" ], "variable": [], "query": [] }, "description": "Returns the bank accounts of the company." } }, { "name": "Create bank account", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"BankName\": \"İŞ BANKASI\",\n \"Name\": \"İş Bankası TRY Hesabı\",\n \"BranchName\": \"\",\n \"BranchCode\": \"\",\n \"AccountNumber\": \"\",\n \"Iban\": \"\",\n \"AccountType\": 1,\n \"CurrencyCode\": \"TRY\",\n \"IsDisabled\": false,\n \"SharingCode\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts" ], "variable": [], "query": [] }, "description": "Adds a bank account." } }, { "name": "Get bank account", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] } } }, { "name": "Update bank account", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"BankName\": \"İŞ BANKASI\",\n \"Name\": \"İş Bankası TRY Hesabı\",\n \"BranchName\": \"\",\n \"BranchCode\": \"\",\n \"AccountNumber\": \"\",\n \"Iban\": \"\",\n \"AccountType\": 1,\n \"CurrencyCode\": \"TRY\",\n \"IsDisabled\": false,\n \"SharingCode\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] }, "description": "Replaces all fields of the bank account." } }, { "name": "Partially update bank account", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"BankName\": \"İŞ BANKASI\",\n \"Name\": \"İş Bankası TRY Hesabı\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared." } }, { "name": "Delete bank account", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] }, "description": "Deletes the bank account. An account used by bank movements or a repayment plan cannot be deleted." } } ] }, { "name": "Repayment Plans", "item": [ { "name": "List repayment plans", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId/repayment-plans", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId", "repayment-plans" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] }, "description": "Returns the repayment plans of the bank account, with their commission rates." } }, { "name": "Create repayment plan", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"3 Taksit\",\n \"DayCount\": 90,\n \"CommissionRates\": [\n {\n \"Name\": \"3 Taksit\",\n \"Rate\": 2.5,\n \"ExpenseCode\": \"MSR-0001\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId/repayment-plans", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId", "repayment-plans" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." } ], "query": [] }, "description": "Adds a repayment plan with its commission rates in one transaction. The bank account must be a POS account (AccountType 3)." } }, { "name": "Get repayment plan", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId/repayment-plans/:repaymentPlanId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId", "repayment-plans", ":repaymentPlanId" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." }, { "key": "repaymentPlanId", "value": "", "description": "Repayment plan ID." } ], "query": [] } } }, { "name": "Update repayment plan", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"3 Taksit\",\n \"DayCount\": 90,\n \"CommissionRates\": [\n {\n \"Name\": \"3 Taksit\",\n \"Rate\": 2.5,\n \"ExpenseCode\": \"MSR-0001\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId/repayment-plans/:repaymentPlanId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId", "repayment-plans", ":repaymentPlanId" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." }, { "key": "repaymentPlanId", "value": "", "description": "Repayment plan ID." } ], "query": [] }, "description": "Replaces all fields of the repayment plan, and replaces its commission rates." } }, { "name": "Partially update repayment plan", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Name\": \"3 Taksit\",\n \"DayCount\": 90\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId/repayment-plans/:repaymentPlanId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId", "repayment-plans", ":repaymentPlanId" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." }, { "key": "repaymentPlanId", "value": "", "description": "Repayment plan ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when CommissionRates is sent it replaces all commission rates, when it is not sent they stay as they are." } }, { "name": "Delete repayment plan", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-accounts/:bankAccountId/repayment-plans/:repaymentPlanId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-accounts", ":bankAccountId", "repayment-plans", ":repaymentPlanId" ], "variable": [ { "key": "bankAccountId", "value": "", "description": "Bank account ID." }, { "key": "repaymentPlanId", "value": "", "description": "Repayment plan ID." } ], "query": [] }, "description": "Deletes the repayment plan and its commission rates. A repayment plan referenced by other records cannot be deleted." } } ] }, { "name": "Bank Transfers", "item": [ { "name": "List bank transfers", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-transfers?page=1&pageSize=50&search=&transferType=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-transfers" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in VoucherNumber and Description.", "disabled": true }, { "key": "transferType", "value": "", "description": "Returns only vouchers of this type: 1 incoming, 2 outgoing.", "disabled": true } ] }, "description": "Returns bank transfer vouchers page by page, newest first, without their lines. Use Get bank transfer to read the lines." } }, { "name": "Create bank transfer", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"TransferType\": 1,\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T14:06:00\",\n \"BankAccountCode\": \"TEST POS\",\n \"Description\": \"\",\n \"SharingCode\": \"\",\n \"Lines\": [\n {\n \"CustomerCode\": \"C-0001\",\n \"Amount\": 500,\n \"ExchangeRate\": 1,\n \"Description\": \"\",\n \"CustomerAmount\": 0,\n \"CustomerCurrencyCode\": \"\",\n \"CustomerExchangeRate\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-transfers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-transfers" ], "variable": [], "query": [] }, "description": "Creates a bank transfer voucher with its lines in one transaction. Each line records money against a customer; the customer's own ledger entry mirrors the line's Amount/ExchangeRate unless CustomerAmount/CustomerCurrencyCode/CustomerExchangeRate override it. The voucher's exchange rate is the amount-weighted average of the lines' ExchangeRate. Send VoucherNumber as \"Next\" to generate it from the company's bank voucher number series." } }, { "name": "Get bank transfer", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-transfers/:bankTransferId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-transfers", ":bankTransferId" ], "variable": [ { "key": "bankTransferId", "value": "", "description": "Bank transfer ID." } ], "query": [] }, "description": "Returns the bank transfer voucher with its lines." } }, { "name": "Update bank transfer", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"TransferType\": 1,\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T14:06:00\",\n \"BankAccountCode\": \"TEST POS\",\n \"Description\": \"\",\n \"SharingCode\": \"\",\n \"Lines\": [\n {\n \"CustomerCode\": \"C-0001\",\n \"Amount\": 500,\n \"ExchangeRate\": 1,\n \"Description\": \"\",\n \"CustomerAmount\": 0,\n \"CustomerCurrencyCode\": \"\",\n \"CustomerExchangeRate\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-transfers/:bankTransferId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-transfers", ":bankTransferId" ], "variable": [ { "key": "bankTransferId", "value": "", "description": "Bank transfer ID." } ], "query": [] }, "description": "Replaces all fields of the voucher, and replaces its lines: the order in which lines are sent determines their identity (the line at the same position as an existing line is treated as that line), a shorter list removes the trailing lines, a longer list adds new ones at the end. TransferType cannot be changed and VoucherNumber cannot be \"Next\". A posted voucher (already sent to accounting) cannot be updated. Changing the customer, amount, currency or rate of a line whose customer record has already been closed by a collection/payment or has a payment plan is rejected." } }, { "name": "Partially update bank transfer", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"TransferType\": 1,\n \"VoucherNumber\": \"Next\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-transfers/:bankTransferId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-transfers", ":bankTransferId" ], "variable": [ { "key": "bankTransferId", "value": "", "description": "Bank transfer ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines (with the same line-identity rule as a full update), when it is not sent the lines stay as they are." } }, { "name": "Delete bank transfer", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-transfers/:bankTransferId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-transfers", ":bankTransferId" ], "variable": [ { "key": "bankTransferId", "value": "", "description": "Bank transfer ID." } ], "query": [] }, "description": "Deletes the voucher and its lines. A posted voucher cannot be deleted, and a line whose customer record has already been closed by a collection/payment or has a payment plan blocks the whole delete." } } ] }, { "name": "Bank Openings", "item": [ { "name": "List bank openings", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-openings?page=1&pageSize=50&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-openings" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in VoucherNumber and Description.", "disabled": true } ] }, "description": "Returns bank opening vouchers page by page, newest first, without their lines. Use Get bank opening to read the lines." } }, { "name": "Create bank opening", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T14:06:00\",\n \"Description\": \"\",\n \"SharingCode\": \"\",\n \"Lines\": [\n {\n \"BankAccountCode\": \"TEST POS\",\n \"Debit\": 0,\n \"Credit\": 500,\n \"ExchangeRate\": 1,\n \"Description\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-openings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-openings" ], "variable": [], "query": [] }, "description": "Creates a bank opening voucher with its lines in one transaction. Each line picks its own bank account (BankAccountCode) and carries either a Debit or a Credit amount, in the account's own currency. Send VoucherNumber as \"Next\" to generate it from the company's bank voucher number series. Unlike a bank internal transfer, the total Debit and total Credit of the lines do not need to be equal." } }, { "name": "Get bank opening", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-openings/:bankOpeningId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-openings", ":bankOpeningId" ], "variable": [ { "key": "bankOpeningId", "value": "", "description": "Bank opening ID." } ], "query": [] }, "description": "Returns the bank opening voucher with its lines." } }, { "name": "Update bank opening", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T14:06:00\",\n \"Description\": \"\",\n \"SharingCode\": \"\",\n \"Lines\": [\n {\n \"BankAccountCode\": \"TEST POS\",\n \"Debit\": 0,\n \"Credit\": 500,\n \"ExchangeRate\": 1,\n \"Description\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-openings/:bankOpeningId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-openings", ":bankOpeningId" ], "variable": [ { "key": "bankOpeningId", "value": "", "description": "Bank opening ID." } ], "query": [] }, "description": "Replaces all fields of the voucher and replaces its lines (the existing lines are removed and the lines in the request are saved). VoucherNumber cannot be \"Next\". A posted voucher (already sent to accounting) cannot be updated." } }, { "name": "Partially update bank opening", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T14:06:00\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-openings/:bankOpeningId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-openings", ":bankOpeningId" ], "variable": [ { "key": "bankOpeningId", "value": "", "description": "Bank opening ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines, when it is not sent the lines stay as they are." } }, { "name": "Delete bank opening", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-openings/:bankOpeningId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-openings", ":bankOpeningId" ], "variable": [ { "key": "bankOpeningId", "value": "", "description": "Bank opening ID." } ], "query": [] }, "description": "Deletes the voucher and its lines. A posted voucher cannot be deleted." } } ] }, { "name": "Bank Internal Transfers", "item": [ { "name": "List bank internal transfers", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-internal-transfers?page=1&pageSize=50&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-internal-transfers" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in VoucherNumber and Description.", "disabled": true } ] }, "description": "Returns bank internal transfer (virman) vouchers page by page, newest first, without their lines. Use Get bank internal transfer to read the lines." } }, { "name": "Create bank internal transfer", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T14:06:00\",\n \"Description\": \"\",\n \"SharingCode\": \"\",\n \"Lines\": [\n {\n \"BankAccountCode\": \"TEST POS\",\n \"Debit\": 0,\n \"Credit\": 500,\n \"ExchangeRate\": 1,\n \"Description\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-internal-transfers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-internal-transfers" ], "variable": [], "query": [] }, "description": "Creates a bank internal transfer (virman) voucher with its lines in one transaction. Each line picks its own bank account (BankAccountCode) and carries either a Debit or a Credit amount, in the account's own currency. The total Debit of all lines must equal the total Credit of all lines. Send VoucherNumber as \"Next\" to generate it from the company's bank voucher number series." } }, { "name": "Get bank internal transfer", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-internal-transfers/:bankInternalTransferId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-internal-transfers", ":bankInternalTransferId" ], "variable": [ { "key": "bankInternalTransferId", "value": "", "description": "Bank internal transfer ID." } ], "query": [] }, "description": "Returns the bank internal transfer voucher with its lines." } }, { "name": "Update bank internal transfer", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T14:06:00\",\n \"Description\": \"\",\n \"SharingCode\": \"\",\n \"Lines\": [\n {\n \"BankAccountCode\": \"TEST POS\",\n \"Debit\": 0,\n \"Credit\": 500,\n \"ExchangeRate\": 1,\n \"Description\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-internal-transfers/:bankInternalTransferId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-internal-transfers", ":bankInternalTransferId" ], "variable": [ { "key": "bankInternalTransferId", "value": "", "description": "Bank internal transfer ID." } ], "query": [] }, "description": "Replaces all fields of the voucher and replaces its lines (the existing lines are removed and the lines in the request are saved). VoucherNumber cannot be \"Next\". A posted voucher (already sent to accounting) cannot be updated." } }, { "name": "Partially update bank internal transfer", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T14:06:00\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-internal-transfers/:bankInternalTransferId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-internal-transfers", ":bankInternalTransferId" ], "variable": [ { "key": "bankInternalTransferId", "value": "", "description": "Bank internal transfer ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines, when it is not sent the lines stay as they are." } }, { "name": "Delete bank internal transfer", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/bank-internal-transfers/:bankInternalTransferId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "bank-internal-transfers", ":bankInternalTransferId" ], "variable": [ { "key": "bankInternalTransferId", "value": "", "description": "Bank internal transfer ID." } ], "query": [] }, "description": "Deletes the voucher and its lines. A posted voucher cannot be deleted." } } ] }, { "name": "Credit Card Collections", "item": [ { "name": "List credit card collections", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/credit-card-collections?page=1&pageSize=50&search=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "credit-card-collections" ], "variable": [], "query": [ { "key": "page", "value": "1", "description": "Page number, starting from 1.", "disabled": false }, { "key": "pageSize", "value": "50", "description": "Records per page (maximum 50).", "disabled": false }, { "key": "search", "value": "", "description": "Searches in VoucherNumber and Description.", "disabled": true } ] }, "description": "Returns credit card collection vouchers page by page, newest first, without their lines. Use Get credit card collection to read the lines." } }, { "name": "Create credit card collection", "request": { "method": "POST", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T16:02:00\",\n \"BankAccountCode\": \"TEST POS\",\n \"Description\": \"\",\n \"SharingCode\": \"\",\n \"Lines\": [\n {\n \"CustomerCode\": \"C-0001\",\n \"Amount\": 800,\n \"ExchangeRate\": 1,\n \"PosChargeDate\": \"2026-09-24T16:03:00\",\n \"RepaymentPlanName\": \"\",\n \"Description\": \"\",\n \"CustomerAmount\": 0,\n \"CustomerCurrencyCode\": \"\",\n \"CustomerExchangeRate\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/credit-card-collections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "credit-card-collections" ], "variable": [], "query": [] }, "description": "Creates a credit card collection voucher with its lines in one transaction. Each line records money collected from a customer's credit card; the customer's own ledger entry mirrors the line's Amount/ExchangeRate unless CustomerAmount/CustomerCurrencyCode/CustomerExchangeRate override it. PosChargeDate is required on every line. When RepaymentPlanName is sent, the line's value date (Valor) is calculated as the voucher Date plus the plan's DayCount. Send VoucherNumber as \"Next\" to generate it from the company's bank voucher number series." } }, { "name": "Get credit card collection", "request": { "method": "GET", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/credit-card-collections/:creditCardCollectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "credit-card-collections", ":creditCardCollectionId" ], "variable": [ { "key": "creditCardCollectionId", "value": "", "description": "Credit card collection ID." } ], "query": [] }, "description": "Returns the credit card collection voucher with its lines." } }, { "name": "Update credit card collection", "request": { "method": "PUT", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T16:02:00\",\n \"BankAccountCode\": \"TEST POS\",\n \"Description\": \"\",\n \"SharingCode\": \"\",\n \"Lines\": [\n {\n \"CustomerCode\": \"C-0001\",\n \"Amount\": 800,\n \"ExchangeRate\": 1,\n \"PosChargeDate\": \"2026-09-24T16:03:00\",\n \"RepaymentPlanName\": \"\",\n \"Description\": \"\",\n \"CustomerAmount\": 0,\n \"CustomerCurrencyCode\": \"\",\n \"CustomerExchangeRate\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/credit-card-collections/:creditCardCollectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "credit-card-collections", ":creditCardCollectionId" ], "variable": [ { "key": "creditCardCollectionId", "value": "", "description": "Credit card collection ID." } ], "query": [] }, "description": "Replaces all fields of the voucher, and replaces its lines: the order in which lines are sent determines their identity (the line at the same position as an existing line is treated as that line), a shorter list removes the trailing lines, a longer list adds new ones at the end. VoucherNumber cannot be \"Next\". A posted voucher, or one already settled by a bank repayment voucher, cannot be updated. Changing the customer, amount, currency or rate of a line whose customer record has already been closed by a collection/payment or has a payment plan is rejected." } }, { "name": "Partially update credit card collection", "request": { "method": "PATCH", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"VoucherNumber\": \"Next\",\n \"Date\": \"2026-09-24T16:02:00\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/finance/credit-card-collections/:creditCardCollectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "credit-card-collections", ":creditCardCollectionId" ], "variable": [ { "key": "creditCardCollectionId", "value": "", "description": "Credit card collection ID." } ], "query": [] }, "description": "Changes only the fields sent in the body (JSON Merge Patch). Fields that are not sent keep their current values; a field sent as null is cleared. Lists are not merged: when Lines is sent it replaces all lines (with the same line-identity rule as a full update), when it is not sent the lines stay as they are." } }, { "name": "Delete credit card collection", "request": { "method": "DELETE", "header": [ { "key": "X-UserID", "value": "{{userId}}", "description": "ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.", "disabled": false }, { "key": "X-CompanyID", "value": "{{companyId}}", "description": "ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.", "disabled": false }, { "key": "X-PeriodID", "value": "{{periodId}}", "description": "ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/api/v1/finance/credit-card-collections/:creditCardCollectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "finance", "credit-card-collections", ":creditCardCollectionId" ], "variable": [ { "key": "creditCardCollectionId", "value": "", "description": "Credit card collection ID." } ], "query": [] }, "description": "Deletes the voucher and its lines. A posted voucher, or one already settled by a bank repayment voucher, cannot be deleted, and a line whose customer record has already been closed by a collection/payment or has a payment plan blocks the whole delete." } } ] } ] } ] }