GET api/Refund?facturation_handle={facturation_handle}&transactionId={transactionId}&invoiceTransactionId={invoiceTransactionId}&date_transaction={date_transaction}&user={user}

Return a list of refunds

Request Information

URI Parameters

Name	Description	Type	Additional information
facturation_handle	Optional - The facturation handle of the refunds returned - takes user or logged in user as default	string	None.
transactionId	Optional - the transaction id of a refund	string	None.
invoiceTransactionId	Optional - the transaction id of an invoice	string	None.
date_transaction	Optional - returns refunds with a transaction date greater than	date	None.
user	Optional user handle - if empty logged in user will be used	string	None.

Body Parameters

None.

Response Information

Resource Description

A list of refunds on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error

Collection of Refund

Name	Description	Type	Additional information
Id	Invoice id	integer	None.
RefundTransactionId	Transaction id of the refund	string	None.
InvoiceTransactionId	Transaction id of the invoice	string	None.
Contents	Invoice	string	None.
InvoiceDate	Invoice date	date	None.
TotalTTC	Total TTC of the transaction	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "RefundTransactionId": "sample string 2",
    "InvoiceTransactionId": "sample string 3",
    "Contents": "sample string 4",
    "InvoiceDate": "2026-07-04T09:49:52.1359555+02:00",
    "TotalTTC": 6.0
  },
  {
    "Id": 1,
    "RefundTransactionId": "sample string 2",
    "InvoiceTransactionId": "sample string 3",
    "Contents": "sample string 4",
    "InvoiceDate": "2026-07-04T09:49:52.1359555+02:00",
    "TotalTTC": 6.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Invoice">
  <Refund>
    <Contents>sample string 4</Contents>
    <Id>1</Id>
    <InvoiceDate>2026-07-04T09:49:52.1359555+02:00</InvoiceDate>
    <InvoiceTransactionId>sample string 3</InvoiceTransactionId>
    <RefundTransactionId>sample string 2</RefundTransactionId>
    <TotalTTC>6</TotalTTC>
  </Refund>
  <Refund>
    <Contents>sample string 4</Contents>
    <Id>1</Id>
    <InvoiceDate>2026-07-04T09:49:52.1359555+02:00</InvoiceDate>
    <InvoiceTransactionId>sample string 3</InvoiceTransactionId>
    <RefundTransactionId>sample string 2</RefundTransactionId>
    <TotalTTC>6</TotalTTC>
  </Refund>
</ArrayOfRefund>