Skip to main content
PATCH
Partially update sales invoice
In the body you send only the fields you want to change; fields that are not sent keep their current values. Rules and examples: partial update.
  • Only the descriptive fields listed in Update sales invoice can be changed; any other field (lines, customer, date, invoice number, amounts, …) is rejected (0002).
  • A field that is not sent does not change; a field sent as null is cleared.
  • Lists (PaymentMeans, ReferencedDespatches, CustomerIdentitySchemes) are not merged: a list you send replaces the whole list.

Error codes

Codes this endpoint can return. The general errors that apply to every endpoint (authentication, permissions, request headers, request limits) are not repeated here.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

invoiceId
string<uuid>
required

Sales invoice ID.

Body

Description
null | string

Description. At most 1000 characters.

DocumentNumber
null | string

Document number (free text). At most 100 characters.

ShipmentDefinitionCode
null | string

Shipment definition code from GET /api/v1/definitions/shipment-definitions.

SharingCode
null | string

Sharing code that limits who can see the invoice. Empty means visible to everyone; otherwise it must be one of the user's sharing codes.

PrintDescription
boolean

Whether the description should be printed on the invoice document.

Consolidated
boolean

Whether the invoice consolidates several despatches/orders. Free-form flag, not validated by the API.

ReturnedInvoiceNumber
null | string

Number of the invoice this one returns goods against (Alış/Satış İade). Free text, not validated against an existing invoice.

ReturnedInvoiceDate
null | string<date>

Date of the invoice this one returns goods against. Date only (yyyy-MM-dd), no time part.

Example:

"2026-10-15"

OrderReferenceNumber
null | string

Reference order number (free text, informational only).

OrderReferenceDate
null | string<date>

Date of the reference order. Date only (yyyy-MM-dd), no time part.

Example:

"2026-10-15"

BranchNumber
null | string

Branch number (informational).

BranchTitle
null | string

Branch title (informational).

BranchAddress
null | string

Branch address (informational).

InvestmentIncentiveDocumentNumber
null | string

Investment incentive certificate number.

InvestmentIncentiveDocumentDate
null | string<date>

Investment incentive certificate date. Date only (yyyy-MM-dd), no time part.

Example:

"2026-10-15"

EnergyPeriodStart
null | string<date-time>

Energy period start date/time, for energy sector invoices.

EnergyPeriodEnd
null | string<date-time>

Energy period end date/time, for energy sector invoices.

DeliveryInfo
null | object

Export delivery information. Stored and returned as sent, not validated.

PaymentMeans
object[]

Payment methods. Stored and returned as sent, not validated.

ReferencedDespatches
object[]

Referenced despatches. Stored and returned as sent, not validated.

CustomerIdentitySchemes
object[]

Customer identity schemes. Stored and returned as sent, not validated.

PublicSectorSpendingUnit
null | object

Public sector (Kamu) payer spending unit. Stored and returned as sent, not validated.

SgkInfo
null | object

SGK (social security) invoice information. Stored and returned as sent, not validated.

Response

OK

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required

Response data. Null when Success is false.

Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.