Skip to main content
GET
List purchase return invoices
Purchase return invoices are returned newest first and without their lines; use Get purchase return invoice for the lines.
  • search looks in the invoice number, document number and customer name.
  • Invoices cancelled in Noyax are left out of the list; they can still be read by ID (Cancelled: true).
  • Paging works like the other lists: page starts at 1, pageSize is at most 50.

Filters and sorting

All are optional and can be combined: To synchronize changes, pass your last synchronization time as modifiedSince and sort with sortBy=modifyDate&sortDirection=asc. Send the time in Turkey time without a time zone offset. Deleted documents no longer appear in the list, so they cannot be discovered this way.

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

Query Parameters

page
integer<int32>
default:1

Page number, starting from 1.

pageSize
integer<int32>
default:50

Records per page (maximum 50).

Searches in InvoiceNumber, DocumentNumber and the customer name.

startDate
string<date-time>

Only documents whose Date is on or after this date.

endDate
string<date-time>

Only documents whose Date is on or before this date.

customerCode
string

Only documents of the customer with this code (Code from GET /api/v1/customers).

currencyCode
string

Only documents in this currency (Code from GET /api/v1/definitions/currencies).

modifiedSince
string<date-time>

Only documents created or modified at or after this date and time (ISO 8601). A document that was never modified counts by its creation time. Use it to fetch changes since your last synchronization.

createdSince
string<date-time>

Only documents created at or after this date and time (ISO 8601).

sortBy
string

Sort field: date (default; the document's date and time), modifyDate (last modified, or created when never modified), createDate or number.

sortDirection
string

asc or desc. Defaults to desc (newest first).

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.