Skip to main content
Backward compatible changes are released in the current version; breaking changes come with a new version. See Versioning.
v1

Initial release

  • Customers: list, get, create, update, delete, with sub-records (addresses, telephones, links, representatives, bank accounts, groups, parameters). CustomerCode: "Next" generates the code from the number series; QueryEInvoiceLabels queries the e-invoice labels when creating. The list returns each customer’s e-mail addresses, telephone numbers and group memberships; its search matches the name by “contains” and the customer code, tax number and e-mail addresses exactly.
  • Products: full CRUD with prices, parameters, group details and critical stock definitions, created together with the product in one transaction. Additional taxes are sent as the AdditionalTaxes list (at most 3, UBL-TR codes, each code once). Quote, order, despatch and invoice lines accept the product’s e-commerce code (ECommerceProductCode) instead of ProductCode. When creating an invoice, the customer can be given by tax number (CustomerTaxNumber) instead of CustomerCode. Product responses return the main product of a variant (MainProductId, MainProductCode; empty for a main product).
  • Changed products (GET /products/changes): all products for the initial load, then those whose card, prices, stock or product groups changed in the last 24 hours at most, each with a card summary and product groups (a variant without product groups gets its main product’s groups, GroupsFromMainProduct), its prices that have not expired (a variant without prices of its own gets its main product’s prices, PricesFromMainProduct) and the stock per warehouse with lots and serial numbers, for periodic synchronization (changed products).
  • Definitions: countries, cities, districts, shipment definitions, currencies, units, line groups, customer and product parameter definitions; VAT rates and customer groups are read-only.
  • Stock: warehouses and sections, a product stock status report, and critical stock controls set to “stop the operation”, which reject a despatch or an invoice stock movement that would leave the stock negative (4402), below the minimum (4401) or above the maximum (4403).
  • Quotes, orders, despatches and invoices (purchase, sales, purchase-return and sales-return, each under its own endpoint group): list, get, create, update, partial update and delete. Lines, discounts and, where applicable, Lot/serial number entries and the customer ledger entry are written in the same transaction. The integrator sends the line amounts; the API does not calculate them but checks that they add up (5118/6120/7124/3126), and fills the header totals and AverageExchangeRate from the lines. UnitPrice excludes VAT; the optional GrossAmount is the amount before discounts. A line’s AdditionalTaxes (at most 3) follow the same code rules as products.
  • Updating despatches and invoices (PUT/PATCH) changes only descriptive fields; lines, customer, date, number and amounts cannot be updated (0002). An invoice already sent to GİB (3027) and a despatch already sent as an e-Despatch (7019) cannot be deleted.
  • e-Document numbering: with "Next", an invoice or outbound despatch numbered from the e-Invoice, e-Archive or e-Despatch numbering continues from the highest number already used with the same prefix and year, so numbers no longer fall behind the ones issued in Noyax and the sequence starts again at 1 every year. A sales or purchase-return invoice of a company that uses e-Invoice is an e-Invoice (EInvoiceType 1) when the customer is a registered e-Invoice user and an e-Archive invoice (2) otherwise. Sales and purchase return invoices share one numbering: the SATFATNO series when the company does not use e-Invoice, and InvoiceNumber is unique among both.
  • Finance: customer transactions and balances reports; banks, bank accounts and repayment plans; incoming/outgoing transfer, opening, internal transfer and credit card collection vouchers (Finance overview). It has its own read/write permission.
  • Risk limit: when a customer’s RiskAction is 2 (stop the operation), a sales order with a customer movement, a sales invoice or a purchase-return invoice that would exceed the customer’s risk limit is rejected (6020, 3028) (customers).
  • Document list filters: date range, customer, currency, modifiedSince/createdSince, sortBy and sortDirection.
  • References by code or name: other records are referenced by code or name (product code, customer code, currency code, unit, warehouse, …), not by ID. A value that is not found returns the error code of its field; one that matches several records returns 0580.
  • Partial update: every updatable resource supports PATCH.
  • Errors: every response carries ResultCode and Errors (result codes). A duplicate value returns the existing record’s ID as ExistingId. A field that is not part of the request is rejected with 0002 on POST, PUT and PATCH. A value that does not fit returns 400 (0003/0004) instead of 500; 500 responses carry a TraceId for support. Unknown paths, methods and content types return the standard error envelope (0005, 0006, 0007).
  • Limits: a daily request limit and a per-second rate limit per API key (rate limits).