GET api/Invoice?facturation_handle={facturation_handle}&transactionId={transactionId}&date_transaction={date_transaction}&user={user}
Return a list of invoices
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| facturation_handle |
Optional - The facturation handle of the invoices returned - takes user or logged in user as default |
string |
None. |
| transactionId |
Optional - the transaction id of a facture |
string |
None. |
| date_transaction |
Optional - returns factures 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 invoices on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Invoice id |
integer |
None. |
| TransactionId |
Transaction id |
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
[
{
"Id": 1,
"TransactionId": "sample string 2",
"Contents": "sample string 3",
"InvoiceDate": "2025-12-13T16:31:55.1899869+01:00",
"TotalTTC": 5.0
},
{
"Id": 1,
"TransactionId": "sample string 2",
"Contents": "sample string 3",
"InvoiceDate": "2025-12-13T16:31:55.1899869+01:00",
"TotalTTC": 5.0
}
]
application/xml, text/xml
<ArrayOfInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Invoice">
<Invoice>
<Contents>sample string 3</Contents>
<Id>1</Id>
<InvoiceDate>2025-12-13T16:31:55.1899869+01:00</InvoiceDate>
<TotalTTC>5</TotalTTC>
<TransactionId>sample string 2</TransactionId>
</Invoice>
<Invoice>
<Contents>sample string 3</Contents>
<Id>1</Id>
<InvoiceDate>2025-12-13T16:31:55.1899869+01:00</InvoiceDate>
<TotalTTC>5</TotalTTC>
<TransactionId>sample string 2</TransactionId>
</Invoice>
</ArrayOfInvoice>