/v23.1/Reports
  • 05 Jun 2024
  • 3 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/Reports

  • Dark
    Light
  • PDF

Article summary

Get
/v23.1/Reports
Security
HTTP
Type Bearer

Please enter a valid token

Query parameters
StoreId
integer (int32)
Description
string
ReportType
string
Valid values[ "NotSpecified", "StandardReport", "ConceptInvoice", "Invoice", "ConceptStandardPurchaseOrder", "StandardPurchaseOrder", "Offer", "ConceptSaleOrder", "SaleOrder", "NotPrintedReservation", "Reservation", "InvoiceJournal", "Delivery", "InvoiceSale", "ConceptInvoiceSale", "CopyStandardPurchaseOrder", "CopyInvoice", "CopySaleOrder", "ProductList", "PrePaymentRequest", "NotPrintedGiftcards", "CopyInvoiceSale", "GiftCardLetter", "LoyaltyCardLetter", "LabelReport", "OrderPicking", "Quote", "ConceptQuote", "CopyQuote", "StockTransaction", "StockTransactionJournal", "LoyaltyCardSettlement", "PayableInvoiceJournal", "ConceptDropshipmentPurchaseOrder", "DropshipmentPurchaseOrder", "CopyDropshipmentPurchaseOrder", "TransportDeclaration" ]
ReportNumber
integer (int32)
SubReportNumber
integer (int32)
IsHideReport
string
Valid values[ "All", "Yes", "No" ]
CategoryNumbers
string
ReportNumbers
string
DerivedReportsOnly
string
Valid values[ "All", "Yes", "No" ]
ReportCategoryId
integer (int32)
LanguageId
integer (int32)
ExcludeReportDefinition
string
Valid values[ "All", "Yes", "No" ]
ExcludeLocalization
string
Valid values[ "All", "Yes", "No" ]
ItemId
integer (int32)
IncludeItemId
integer (int32)
ExcludeItemId
integer (int32)
ModifiedSinceDateTime
string (date-time)
Responses
200

Success

Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
storeId
integer (int32)
parentReportId
integer (int32)
description
string
reportNumber
integer (int32)
actualReportNumber
integer (int32)
subReportNumber
integer (int32)
reportType
string
Valid values[ "NotSpecified", "StandardReport", "ConceptInvoice", "Invoice", "ConceptStandardPurchaseOrder", "StandardPurchaseOrder", "Offer", "ConceptSaleOrder", "SaleOrder", "NotPrintedReservation", "Reservation", "InvoiceJournal", "Delivery", "InvoiceSale", "ConceptInvoiceSale", "CopyStandardPurchaseOrder", "CopyInvoice", "CopySaleOrder", "ProductList", "PrePaymentRequest", "NotPrintedGiftcards", "CopyInvoiceSale", "GiftCardLetter", "LoyaltyCardLetter", "LabelReport", "OrderPicking", "Quote", "ConceptQuote", "CopyQuote", "StockTransaction", "StockTransactionJournal", "LoyaltyCardSettlement", "PayableInvoiceJournal", "ConceptDropshipmentPurchaseOrder", "DropshipmentPurchaseOrder", "CopyDropshipmentPurchaseOrder", "TransportDeclaration" ]
selectionForm
string
Valid values[ "None", "Default", "ProductMaintenance", "ReceivedProducts", "ConceptPurchaseOrder", "FinalPurchaseOrder", "ConceptInvoice", "FinalInvoice", "ConceptInvoiceSale", "FinalInvoiceSale", "PrintInvoiceJournals", "EftJournals", "CopyInvoice", "CashDeclarationJournals", "CashDeclarationAttributes", "PurchaseOrders", "CashDeclarationCounts", "ZipCodeResearch", "ConceptSaleOrder", "FinalSaleOrder", "CopySaleOrder", "CopyPurchaseOrder", "ProductList", "NotPrintedReservations", "Reservations", "SaleOrders", "ProductLocations", "PosReport", "GiftCardA4", "ObservationAtLocation", "CashFlows", "LoyaltyCards", "PrePayments", "Customers", "GiftCard", "InboundInvoices", "ReturnGoods", "ProductChanges", "PosExceptions", "ChangedArticlesPerExchangeRemark", "SalePerformance", "BackOrder", "ShelfDisplay", "Payments", "Quotes", "ConceptQuote", "FinalQuote", "CopyQuote", "BlanketOrder", "AccountsReceivable", "PriceAgreements", "StockTransactions", "StockTransactionJournals", "OrderPicking", "LoyaltyCardUpdates", "PayableInvoiceJournals", "PosCorrections", "ProductCountPerSupplier", "LocalProductsOnFranchiseSuppliers", "CashSalePayments", "ConceptDropshipmentPurchaseOrder", "FinalDropshipmentPurchaseOrder", "CopyDropshipmentPurchaseOrder", "StoreLocationProducts", "CustomerNotes", "ExternalProductPrices", "SalesStatistics" ]
sort1Description
string
sort1Text
string
sort2Description
string
sort2Text
string
sort3Description
string
sort3Text
string
sort4Description
string
sort4Text
string
sort5Description
string
sort5Text
string
sort6Description
string
sort6Text
string
followupNumber
integer (int32)
isAvailableInPos
boolean
Default"False"
isHideReport
boolean
Default"False"
isMultiLanguage
boolean
Default"False"
reportDefinition
string
localization
string
dataSource
string
converted
boolean
Default"False"
displayReportNumber
string
isDerived
boolean
Default"False"
localizedDescription
string
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
storeId
integer (int32)
parentReportId
integer (int32)
description
string
reportNumber
integer (int32)
actualReportNumber
integer (int32)
subReportNumber
integer (int32)
reportType
string
Valid values[ "NotSpecified", "StandardReport", "ConceptInvoice", "Invoice", "ConceptStandardPurchaseOrder", "StandardPurchaseOrder", "Offer", "ConceptSaleOrder", "SaleOrder", "NotPrintedReservation", "Reservation", "InvoiceJournal", "Delivery", "InvoiceSale", "ConceptInvoiceSale", "CopyStandardPurchaseOrder", "CopyInvoice", "CopySaleOrder", "ProductList", "PrePaymentRequest", "NotPrintedGiftcards", "CopyInvoiceSale", "GiftCardLetter", "LoyaltyCardLetter", "LabelReport", "OrderPicking", "Quote", "ConceptQuote", "CopyQuote", "StockTransaction", "StockTransactionJournal", "LoyaltyCardSettlement", "PayableInvoiceJournal", "ConceptDropshipmentPurchaseOrder", "DropshipmentPurchaseOrder", "CopyDropshipmentPurchaseOrder", "TransportDeclaration" ]
selectionForm
string
Valid values[ "None", "Default", "ProductMaintenance", "ReceivedProducts", "ConceptPurchaseOrder", "FinalPurchaseOrder", "ConceptInvoice", "FinalInvoice", "ConceptInvoiceSale", "FinalInvoiceSale", "PrintInvoiceJournals", "EftJournals", "CopyInvoice", "CashDeclarationJournals", "CashDeclarationAttributes", "PurchaseOrders", "CashDeclarationCounts", "ZipCodeResearch", "ConceptSaleOrder", "FinalSaleOrder", "CopySaleOrder", "CopyPurchaseOrder", "ProductList", "NotPrintedReservations", "Reservations", "SaleOrders", "ProductLocations", "PosReport", "GiftCardA4", "ObservationAtLocation", "CashFlows", "LoyaltyCards", "PrePayments", "Customers", "GiftCard", "InboundInvoices", "ReturnGoods", "ProductChanges", "PosExceptions", "ChangedArticlesPerExchangeRemark", "SalePerformance", "BackOrder", "ShelfDisplay", "Payments", "Quotes", "ConceptQuote", "FinalQuote", "CopyQuote", "BlanketOrder", "AccountsReceivable", "PriceAgreements", "StockTransactions", "StockTransactionJournals", "OrderPicking", "LoyaltyCardUpdates", "PayableInvoiceJournals", "PosCorrections", "ProductCountPerSupplier", "LocalProductsOnFranchiseSuppliers", "CashSalePayments", "ConceptDropshipmentPurchaseOrder", "FinalDropshipmentPurchaseOrder", "CopyDropshipmentPurchaseOrder", "StoreLocationProducts", "CustomerNotes", "ExternalProductPrices", "SalesStatistics" ]
sort1Description
string
sort1Text
string
sort2Description
string
sort2Text
string
sort3Description
string
sort3Text
string
sort4Description
string
sort4Text
string
sort5Description
string
sort5Text
string
sort6Description
string
sort6Text
string
followupNumber
integer (int32)
isAvailableInPos
boolean
Default"False"
isHideReport
boolean
Default"False"
isMultiLanguage
boolean
Default"False"
reportDefinition
string
localization
string
dataSource
string
converted
boolean
Default"False"
displayReportNumber
string
isDerived
boolean
Default"False"
localizedDescription
string
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
storeId
integer (int32)
parentReportId
integer (int32)
description
string
reportNumber
integer (int32)
actualReportNumber
integer (int32)
subReportNumber
integer (int32)
reportType
string
Valid values[ "NotSpecified", "StandardReport", "ConceptInvoice", "Invoice", "ConceptStandardPurchaseOrder", "StandardPurchaseOrder", "Offer", "ConceptSaleOrder", "SaleOrder", "NotPrintedReservation", "Reservation", "InvoiceJournal", "Delivery", "InvoiceSale", "ConceptInvoiceSale", "CopyStandardPurchaseOrder", "CopyInvoice", "CopySaleOrder", "ProductList", "PrePaymentRequest", "NotPrintedGiftcards", "CopyInvoiceSale", "GiftCardLetter", "LoyaltyCardLetter", "LabelReport", "OrderPicking", "Quote", "ConceptQuote", "CopyQuote", "StockTransaction", "StockTransactionJournal", "LoyaltyCardSettlement", "PayableInvoiceJournal", "ConceptDropshipmentPurchaseOrder", "DropshipmentPurchaseOrder", "CopyDropshipmentPurchaseOrder", "TransportDeclaration" ]
selectionForm
string
Valid values[ "None", "Default", "ProductMaintenance", "ReceivedProducts", "ConceptPurchaseOrder", "FinalPurchaseOrder", "ConceptInvoice", "FinalInvoice", "ConceptInvoiceSale", "FinalInvoiceSale", "PrintInvoiceJournals", "EftJournals", "CopyInvoice", "CashDeclarationJournals", "CashDeclarationAttributes", "PurchaseOrders", "CashDeclarationCounts", "ZipCodeResearch", "ConceptSaleOrder", "FinalSaleOrder", "CopySaleOrder", "CopyPurchaseOrder", "ProductList", "NotPrintedReservations", "Reservations", "SaleOrders", "ProductLocations", "PosReport", "GiftCardA4", "ObservationAtLocation", "CashFlows", "LoyaltyCards", "PrePayments", "Customers", "GiftCard", "InboundInvoices", "ReturnGoods", "ProductChanges", "PosExceptions", "ChangedArticlesPerExchangeRemark", "SalePerformance", "BackOrder", "ShelfDisplay", "Payments", "Quotes", "ConceptQuote", "FinalQuote", "CopyQuote", "BlanketOrder", "AccountsReceivable", "PriceAgreements", "StockTransactions", "StockTransactionJournals", "OrderPicking", "LoyaltyCardUpdates", "PayableInvoiceJournals", "PosCorrections", "ProductCountPerSupplier", "LocalProductsOnFranchiseSuppliers", "CashSalePayments", "ConceptDropshipmentPurchaseOrder", "FinalDropshipmentPurchaseOrder", "CopyDropshipmentPurchaseOrder", "StoreLocationProducts", "CustomerNotes", "ExternalProductPrices", "SalesStatistics" ]
sort1Description
string
sort1Text
string
sort2Description
string
sort2Text
string
sort3Description
string
sort3Text
string
sort4Description
string
sort4Text
string
sort5Description
string
sort5Text
string
sort6Description
string
sort6Text
string
followupNumber
integer (int32)
isAvailableInPos
boolean
Default"False"
isHideReport
boolean
Default"False"
isMultiLanguage
boolean
Default"False"
reportDefinition
string
localization
string
dataSource
string
converted
boolean
Default"False"
displayReportNumber
string
isDerived
boolean
Default"False"
localizedDescription
string
401

Unauthorized

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403

Forbidden

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
404

Not Found

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.