POST api/OmsReporting/financials/transaction-details
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| SiteId | integer |
None. |
|
| SearchByInvoiceDate | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"StartDate": "2025-12-20T20:50:40.2416076+00:00",
"EndDate": "2025-12-20T20:50:40.2416076+00:00",
"SiteId": 1,
"SearchByInvoiceDate": true
}
application/xml, text/xml
Sample:
<SiteStartEndDateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API"> <EndDate>2025-12-20T20:50:40.2416076+00:00</EndDate> <SearchByInvoiceDate>true</SearchByInvoiceDate> <SiteId>1</SiteId> <StartDate>2025-12-20T20:50:40.2416076+00:00</StartDate> </SiteStartEndDateRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
| Name | Description | Type | Additional Information |
|---|---|---|---|
| ResponseCode | APIResponseCodes |
None. |
|
| Message | string |
None. |
|
| CorrelationId | string |
None. |
|
| Model |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseCode": 0,
"Message": "sample string 1",
"CorrelationId": "sample string 2",
"Model": {
"ReportData": null,
"Sites": null,
"CurrentSiteID": 1,
"ReportStartDate": "sample string 2",
"ReportEndDate": "sample string 3",
"TimezoneHourOffset": 4,
"SearchByInvoiceDate": true,
"ValidationError": true,
"CurrentSite": null,
"EnableExport": true,
"ErrorMessages": [
"sample string 1",
"sample string 2"
],
"SalesRecapTables": [
{
"TableTitle": "sample string 1",
"IsDiscountTable": true,
"Rows": [
{
"Label": "sample string 1",
"Sales": 2.0,
"Returns": 3.0,
"Credit": 4.0,
"Total": -5.0,
"SalesFormatted": "sample string 5",
"ReturnsFormatted": "sample string 6",
"CreditFormatted": "sample string 7",
"TotalFormatted": "sample string 8"
},
{
"Label": "sample string 1",
"Sales": 2.0,
"Returns": 3.0,
"Credit": 4.0,
"Total": -5.0,
"SalesFormatted": "sample string 5",
"ReturnsFormatted": "sample string 6",
"CreditFormatted": "sample string 7",
"TotalFormatted": "sample string 8"
}
],
"GrandTotals": {
"Label": "sample string 1",
"Sales": 2.0,
"Returns": 3.0,
"Credit": 4.0,
"Total": -5.0,
"SalesFormatted": "sample string 5",
"ReturnsFormatted": "sample string 6",
"CreditFormatted": "sample string 7",
"TotalFormatted": "sample string 8"
}
},
{
"TableTitle": "sample string 1",
"IsDiscountTable": true,
"Rows": [
{
"Label": "sample string 1",
"Sales": 2.0,
"Returns": 3.0,
"Credit": 4.0,
"Total": -5.0,
"SalesFormatted": "sample string 5",
"ReturnsFormatted": "sample string 6",
"CreditFormatted": "sample string 7",
"TotalFormatted": "sample string 8"
},
{
"Label": "sample string 1",
"Sales": 2.0,
"Returns": 3.0,
"Credit": 4.0,
"Total": -5.0,
"SalesFormatted": "sample string 5",
"ReturnsFormatted": "sample string 6",
"CreditFormatted": "sample string 7",
"TotalFormatted": "sample string 8"
}
],
"GrandTotals": {
"Label": "sample string 1",
"Sales": 2.0,
"Returns": 3.0,
"Credit": 4.0,
"Total": -5.0,
"SalesFormatted": "sample string 5",
"ReturnsFormatted": "sample string 6",
"CreditFormatted": "sample string 7",
"TotalFormatted": "sample string 8"
}
}
],
"TransactionDetails": [
{
"OrderNumber": "sample string 1",
"OrderUrl": "/oms/Order/sample string 1",
"TransactionNumber": "sample string 2",
"ShipmentNumber": "sample string 3",
"InvoiceBillTo": "sample string 4",
"InvoiceNumber": "sample string 5",
"InvoiceAmount": "sample string 6",
"InvoiceDate": "sample string 7",
"TransactionDate": "sample string 8",
"Subtotal": "sample string 9",
"Shipping": "sample string 10",
"ProcessingFee": "sample string 11",
"Tax": "sample string 12",
"TotalCharges": "sample string 13",
"PaymentTransactionType": "sample string 14",
"PaymentType": "sample string 15",
"TransactionAmount": "sample string 16",
"ItemDiscount": "sample string 17",
"OrderDiscount": "sample string 18",
"Processor": "sample string 19",
"IsDecline": "sample string 20",
"OrderPaymentGenerics": [
"sample string 1",
"sample string 2"
],
"PaymentTranGenerics": [
"sample string 1",
"sample string 2"
],
"OrderCustoms": [
"sample string 1",
"sample string 2"
],
"IsExtraPaymentRow": true,
"OmsTransactionType": "sample string 22"
},
{
"OrderNumber": "sample string 1",
"OrderUrl": "/oms/Order/sample string 1",
"TransactionNumber": "sample string 2",
"ShipmentNumber": "sample string 3",
"InvoiceBillTo": "sample string 4",
"InvoiceNumber": "sample string 5",
"InvoiceAmount": "sample string 6",
"InvoiceDate": "sample string 7",
"TransactionDate": "sample string 8",
"Subtotal": "sample string 9",
"Shipping": "sample string 10",
"ProcessingFee": "sample string 11",
"Tax": "sample string 12",
"TotalCharges": "sample string 13",
"PaymentTransactionType": "sample string 14",
"PaymentType": "sample string 15",
"TransactionAmount": "sample string 16",
"ItemDiscount": "sample string 17",
"OrderDiscount": "sample string 18",
"Processor": "sample string 19",
"IsDecline": "sample string 20",
"OrderPaymentGenerics": [
"sample string 1",
"sample string 2"
],
"PaymentTranGenerics": [
"sample string 1",
"sample string 2"
],
"OrderCustoms": [
"sample string 1",
"sample string 2"
],
"IsExtraPaymentRow": true,
"OmsTransactionType": "sample string 22"
}
],
"EnableOrdering": true
}
}
application/xml, text/xml
Sample:
<ReportingSalesModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
<CorrelationId>sample string 2</CorrelationId>
<Message>sample string 1</Message>
<Model xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
<d2p1:CurrentSite i:nil="true" />
<d2p1:CurrentSiteID>1</d2p1:CurrentSiteID>
<d2p1:EnableExport>true</d2p1:EnableExport>
<d2p1:EnableOrdering>true</d2p1:EnableOrdering>
<d2p1:ErrorMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</d2p1:ErrorMessages>
<d2p1:ReportData i:nil="true" />
<d2p1:ReportEndDate>sample string 3</d2p1:ReportEndDate>
<d2p1:ReportStartDate>sample string 2</d2p1:ReportStartDate>
<d2p1:SalesRecapTables>
<d2p1:SalesRecapTableModel>
<d2p1:GrandTotals>
<d2p1:Credit>4</d2p1:Credit>
<d2p1:CreditFormatted>sample string 7</d2p1:CreditFormatted>
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Returns>3</d2p1:Returns>
<d2p1:ReturnsFormatted>sample string 6</d2p1:ReturnsFormatted>
<d2p1:Sales>2</d2p1:Sales>
<d2p1:SalesFormatted>sample string 5</d2p1:SalesFormatted>
<d2p1:TotalFormatted>sample string 8</d2p1:TotalFormatted>
</d2p1:GrandTotals>
<d2p1:IsDiscountTable>true</d2p1:IsDiscountTable>
<d2p1:Rows>
<d2p1:SalesRecapRowModel>
<d2p1:Credit>4</d2p1:Credit>
<d2p1:CreditFormatted>sample string 7</d2p1:CreditFormatted>
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Returns>3</d2p1:Returns>
<d2p1:ReturnsFormatted>sample string 6</d2p1:ReturnsFormatted>
<d2p1:Sales>2</d2p1:Sales>
<d2p1:SalesFormatted>sample string 5</d2p1:SalesFormatted>
<d2p1:TotalFormatted>sample string 8</d2p1:TotalFormatted>
</d2p1:SalesRecapRowModel>
<d2p1:SalesRecapRowModel>
<d2p1:Credit>4</d2p1:Credit>
<d2p1:CreditFormatted>sample string 7</d2p1:CreditFormatted>
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Returns>3</d2p1:Returns>
<d2p1:ReturnsFormatted>sample string 6</d2p1:ReturnsFormatted>
<d2p1:Sales>2</d2p1:Sales>
<d2p1:SalesFormatted>sample string 5</d2p1:SalesFormatted>
<d2p1:TotalFormatted>sample string 8</d2p1:TotalFormatted>
</d2p1:SalesRecapRowModel>
</d2p1:Rows>
<d2p1:TableTitle>sample string 1</d2p1:TableTitle>
</d2p1:SalesRecapTableModel>
<d2p1:SalesRecapTableModel>
<d2p1:GrandTotals>
<d2p1:Credit>4</d2p1:Credit>
<d2p1:CreditFormatted>sample string 7</d2p1:CreditFormatted>
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Returns>3</d2p1:Returns>
<d2p1:ReturnsFormatted>sample string 6</d2p1:ReturnsFormatted>
<d2p1:Sales>2</d2p1:Sales>
<d2p1:SalesFormatted>sample string 5</d2p1:SalesFormatted>
<d2p1:TotalFormatted>sample string 8</d2p1:TotalFormatted>
</d2p1:GrandTotals>
<d2p1:IsDiscountTable>true</d2p1:IsDiscountTable>
<d2p1:Rows>
<d2p1:SalesRecapRowModel>
<d2p1:Credit>4</d2p1:Credit>
<d2p1:CreditFormatted>sample string 7</d2p1:CreditFormatted>
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Returns>3</d2p1:Returns>
<d2p1:ReturnsFormatted>sample string 6</d2p1:ReturnsFormatted>
<d2p1:Sales>2</d2p1:Sales>
<d2p1:SalesFormatted>sample string 5</d2p1:SalesFormatted>
<d2p1:TotalFormatted>sample string 8</d2p1:TotalFormatted>
</d2p1:SalesRecapRowModel>
<d2p1:SalesRecapRowModel>
<d2p1:Credit>4</d2p1:Credit>
<d2p1:CreditFormatted>sample string 7</d2p1:CreditFormatted>
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Returns>3</d2p1:Returns>
<d2p1:ReturnsFormatted>sample string 6</d2p1:ReturnsFormatted>
<d2p1:Sales>2</d2p1:Sales>
<d2p1:SalesFormatted>sample string 5</d2p1:SalesFormatted>
<d2p1:TotalFormatted>sample string 8</d2p1:TotalFormatted>
</d2p1:SalesRecapRowModel>
</d2p1:Rows>
<d2p1:TableTitle>sample string 1</d2p1:TableTitle>
</d2p1:SalesRecapTableModel>
</d2p1:SalesRecapTables>
<d2p1:SearchByInvoiceDate>true</d2p1:SearchByInvoiceDate>
<d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<d2p1:TimezoneHourOffset>4</d2p1:TimezoneHourOffset>
<d2p1:TransactionDetails>
<d2p1:TransactionDetailRowModel>
<d2p1:InvoiceAmount>sample string 6</d2p1:InvoiceAmount>
<d2p1:InvoiceBillTo>sample string 4</d2p1:InvoiceBillTo>
<d2p1:InvoiceDate>sample string 7</d2p1:InvoiceDate>
<d2p1:InvoiceNumber>sample string 5</d2p1:InvoiceNumber>
<d2p1:IsDecline>sample string 20</d2p1:IsDecline>
<d2p1:IsExtraPaymentRow>true</d2p1:IsExtraPaymentRow>
<d2p1:ItemDiscount>sample string 17</d2p1:ItemDiscount>
<d2p1:OmsTransactionType>sample string 22</d2p1:OmsTransactionType>
<d2p1:OrderCustoms xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</d2p1:OrderCustoms>
<d2p1:OrderDiscount>sample string 18</d2p1:OrderDiscount>
<d2p1:OrderNumber>sample string 1</d2p1:OrderNumber>
<d2p1:OrderPaymentGenerics xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</d2p1:OrderPaymentGenerics>
<d2p1:PaymentTranGenerics xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</d2p1:PaymentTranGenerics>
<d2p1:PaymentTransactionType>sample string 14</d2p1:PaymentTransactionType>
<d2p1:PaymentType>sample string 15</d2p1:PaymentType>
<d2p1:ProcessingFee>sample string 11</d2p1:ProcessingFee>
<d2p1:Processor>sample string 19</d2p1:Processor>
<d2p1:ShipmentNumber>sample string 3</d2p1:ShipmentNumber>
<d2p1:Shipping>sample string 10</d2p1:Shipping>
<d2p1:Subtotal>sample string 9</d2p1:Subtotal>
<d2p1:Tax>sample string 12</d2p1:Tax>
<d2p1:TotalCharges>sample string 13</d2p1:TotalCharges>
<d2p1:TransactionAmount>sample string 16</d2p1:TransactionAmount>
<d2p1:TransactionDate>sample string 8</d2p1:TransactionDate>
<d2p1:TransactionNumber>sample string 2</d2p1:TransactionNumber>
</d2p1:TransactionDetailRowModel>
<d2p1:TransactionDetailRowModel>
<d2p1:InvoiceAmount>sample string 6</d2p1:InvoiceAmount>
<d2p1:InvoiceBillTo>sample string 4</d2p1:InvoiceBillTo>
<d2p1:InvoiceDate>sample string 7</d2p1:InvoiceDate>
<d2p1:InvoiceNumber>sample string 5</d2p1:InvoiceNumber>
<d2p1:IsDecline>sample string 20</d2p1:IsDecline>
<d2p1:IsExtraPaymentRow>true</d2p1:IsExtraPaymentRow>
<d2p1:ItemDiscount>sample string 17</d2p1:ItemDiscount>
<d2p1:OmsTransactionType>sample string 22</d2p1:OmsTransactionType>
<d2p1:OrderCustoms xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</d2p1:OrderCustoms>
<d2p1:OrderDiscount>sample string 18</d2p1:OrderDiscount>
<d2p1:OrderNumber>sample string 1</d2p1:OrderNumber>
<d2p1:OrderPaymentGenerics xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</d2p1:OrderPaymentGenerics>
<d2p1:PaymentTranGenerics xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</d2p1:PaymentTranGenerics>
<d2p1:PaymentTransactionType>sample string 14</d2p1:PaymentTransactionType>
<d2p1:PaymentType>sample string 15</d2p1:PaymentType>
<d2p1:ProcessingFee>sample string 11</d2p1:ProcessingFee>
<d2p1:Processor>sample string 19</d2p1:Processor>
<d2p1:ShipmentNumber>sample string 3</d2p1:ShipmentNumber>
<d2p1:Shipping>sample string 10</d2p1:Shipping>
<d2p1:Subtotal>sample string 9</d2p1:Subtotal>
<d2p1:Tax>sample string 12</d2p1:Tax>
<d2p1:TotalCharges>sample string 13</d2p1:TotalCharges>
<d2p1:TransactionAmount>sample string 16</d2p1:TransactionAmount>
<d2p1:TransactionDate>sample string 8</d2p1:TransactionDate>
<d2p1:TransactionNumber>sample string 2</d2p1:TransactionNumber>
</d2p1:TransactionDetailRowModel>
</d2p1:TransactionDetails>
<d2p1:ValidationError>true</d2p1:ValidationError>
</Model>
<ResponseCode>Success</ResponseCode>
</ReportingSalesModelResponse>