Open Reporting API

When printing a sales order, you need to supply the DocumentType element to tell the API which sales order document you want to produce, in this case it is an invoice.

<?xml version="1.0" encoding="windows-1252" ?>
<Query>
  <Option>
    <Function>ONLINE</Function>
    <DocumentType>I</DocumentType>
    <Format>0</Format>
    <Reprint>Y</Reprint>
    <PrintDispatchInvoice>N</PrintDispatchInvoice>
  </Option>
  <Filter>
    <OrderNumber FilterType='S' FilterValue='000791' />
    <InvoiceNumber FilterType='S' FilterValue='100506' />
  </Filter>
</Query>

<?xml version="1.0" encoding="windows-1252" ?>
<Query>
  <Option>
    <Function>ONLINE</Function>
    <DocumentType>I</DocumentType>
    <Format>0</Format>
    <Reprint>Y</Reprint>
    <PrintDispatchInvoice>Y</PrintDispatchInvoice>
  </Option>
  <Filter>
    <InvoiceNumber FilterType="S" FilterValue="100540" />
    <OrderNumber FilterType="S" FilterValue="000000000000945" />
    <DispatchNote FilterType="S" FilterValue="000000000000027" />
  </Filter>
</Query>

The AR Statement format allows for multiple options to be provided via a 3rd party API.

<?xml version="1.0" encoding="Windows-1252"?>
<Query>
  <Option>
    <Function>ONLINE</Function>
    <Format>0</Format>
    <StatementAsOf>C</StatementAsOf>
    <StatementDate />
    <StatementAgeing>S</StatementAgeing>
    <ConsolidateSub>N</ConsolidateSub>
    <IncludeAttached>N</IncludeAttached>
    <AsOpenItem>N</AsOpenItem>
    <BalanceType>A</BalanceType>
    <MinimumBalance>0.00</MinimumBalance>
    <SalesMessage />
  </Option>
  <Filter>
    <Customer FilterType="S" FilterValue="0000001" />
  </Filter>
</Query>

Supported values for the DocumentType element are Purchase orders - Local and Purchase orders - Foreign.

<?xml version="1.0" encoding="windows-1252" ?>
<DocumentControl>
  <DocumentType>Purchase orders - Local</DocumentType>
  <Print>False</Print>
  <Email>False</Email>
  <Preview>True</Preview>
  <XmlOnly>False</XmlOnly>
  <PrinterDetails>
    <PrinterName />
    <PrintCopies>1</PrintCopies>
    <PrintCollate>True</PrintCollate>
  </PrinterDetails>
  <EmailDetails>
    <EmailFromAddress />
    <EmailToAddress />
    <EmailCCAddress />
    <EmailToAddress />
    <EmailBodyText />
  </EmailDetails>
</DocumentControl>

Valid values for the DocumentType element are either L (local) or F (foreign) and the format code selected must have been created for the specified purchase order document type.

<?xml version="1.0" encoding="Windows-1252"?>
<Query>
  <Option>
    <Function>ONLINE</Function>
    <DocumentType>L</DocumentType>
    <Format>0</Format>
    <Reprint>Y</Reprint>
  </Option>
  <Filter>
    <OrderNumber FilterType="S" FilterValue="458" />
  </Filter>
</Query>

This is the sales order number.

This is the sales order status flag.

Sales order status codes

Following the entry of a sales order document into the system, a status code is assigned to the order header indicating its progress within the system.

The status code held against an order determines which functions can be performed at that point, particularly during maintenance and printing.

The current order status is stored in the SorMaster table.

The status may also be stored in the SorMasterRep table, but may not be the same as the status in the SorMaster table.

For example:

For an SCT order, the status in the SorMasterRep table is the order status at the time of performing the transfer, whereas the order status in SorMaster is the current status.

The following are the possible statuses that can be assigned to a sales order header:

Status	Description
0 - Order in process	The entered order is currently being maintained by another user or the End order function was not performed (e.g. a power failure occurred during the entry or maintenance of an order). This status can be reset to the previous status using the Order Maintenance function.
1 - Open order line	An order has been entered into the system. A delivery note must be printed before the order can be released for invoicing. Next status: 4 - In warehouse The following actions place an order into a status of 4 - In warehouse: Printing a delivery note upon ending the order. Printing delivery notes using the Document Print program for sales orders in 1 - Open order line. Using the Sales Order Entry program to manually change the order status from 8 - To invoice to 4 - In warehouse
2 - Open back order	An order or billing contains lines which could not be shipped owing to a stock shortage. The order or billing may have been partially invoiced, but there are remaining lines on back order. Releases for a Blanket Sales Order have been accepted. An order or billing has to pass through the invoicing process at least once to become an open order. You can cancel an order that is in a status 2 - Open back order providing that the order has been partially invoiced and the Cancel open order previously invoiced setup option is enabled (Setup Options > Preferences > Distribution > Sales Orders). Your configuration of the Back orders setup option affects how this status is updated (Setup Options > Preferences > Distribution > Sales Orders): If the option is set to Manual, then the order is set to a status of 2 - Open back order. If the option is set to Automatic, then the order is set to a status of 3 - Released back order. Next status: 3 - Released back order (for orders) 8 - To invoice (for billings)
3 - Released back order	An open back order now has items to be shipped and has been released for delivery note printing. Billings are released into status 8 - To invoice, not status 3 - Released back order. The next delivery note print will produce a delivery note document. Your configuration of the Back orders setup option affects how this status is updated (Setup Options > Preferences > Distribution > Sales Orders): If the option is set to Manual, then the order is set to a status of 2 - Open back order. If the option is set to Automatic, then the order is set to a status of 3 - Released back order. Next status: 4 - In warehouse
4 - In warehouse	A delivery note has been printed for an open order or a released back order. Next status: 8 - To invoice
8 - To invoice	A billing has been entered. A back ordered billing has been released. An order in the warehouse has been released. Next status: 9 - Complete (if completely shipped after invoicing) 2 - Open back order (if any back orders remain)
8 - To transfer	A Supply Chain Transfer order has been entered. Next status: 9 - Complete
F - Forward order	The order is indefinite and must be released before it is processed as a normal order. Next status: 1 - Open order line When releasing a Forward order, the quantity is placed in back order when any of the following are true: The sales order entry preference Automatically put order qty into back order is enabled. There is insufficient stock and negative stock is not allowed for the selected warehouse. Multiple bins are enabled (irrespective of whether stock is being reserved). The item is traceable, ECC-controlled, or serialized. The line is for items that are parents or components of kits (i.e. a single level BOM structure of parent or component exists). Components cannot automatically be released because the stock allocations are required before the lines can be shipped. The Packaging option Requested and mandatory or Requested but optional are selected. These lines must be manually shipped to ensure that packaging details are entered.
S - In suspense	An order or billing has failed credit checking. An order or billing has been placed on hold. Next status: The order reverts to the status in process (0 - Order in process) prior to the order being suspended.
9 - Complete	A sales order has been fully invoiced and will be removed from file when the Order Purge program is run. When a Blanket Sales Order is complete in terms of invoicing, it is set to a status of S - In suspense while waiting for the next release. It is not set to a status of 9 - Complete.
* Cancelled	An order was canceled during entry (i.e. before it was completely entered into the system) and will be removed from the file when the Order Purge program is run.
\ Cancelled	An order was canceled prior to invoicing and will be removed from the file when the Order Purge program is run.
R - Released to picking	Indicates that an order has been released to picking. An open order (status 1 - Open order line) which contains lines for picking, would typically move to a status R - Released to picking and then P - In picking. Sales orders can only be invoiced when the picking cycle has been completed.
P - In picking	Indicates that the order is currently within the picking process. Once picking has completed, the order would return to a status 1 - Open order line, therefore enabling you to add additional lines if required, or proceed to the next required stage.

This is the translated description of the order status.

This flag determines whether the sales order is active.

• Blank - Yes
• N - No
• Z - To be archived

This is the translated description of the active flag.

This flag determines whether the sales order is cancelled.

• Blank - No
• Y - Yes

This is the translated description of the cancelled flag.

This determines the document type, which can be one of the following:

• B - Billing
• O - Order
• C - Credit note
• D - Debit note

This is the translated description of the document type.

This flag determines whether the order acknowledgment document may be printed.

• True - Yes can be printed
• False - No can't be printed

This flag determines whether the order acknowledgment document may be reprinted.

• True - Yes can be reprinted
• False - No can't be reprinted

This flag determines whether the delivery note document may be printed.

• True - Yes can be printed
• False - No can't be printed

This flag determines whether the order acknowledgment document may be reprinted.

• True - Yes can be reprinted
• False - No can't be reprinted

This flag determines whether an invoice can be generated from the sales order.

• True - An invoice can be generated from the sales order
• False - An invoice can't be generated from the sales order

This flag determines whether the dispatch note document may be printed.

• True - Yes can be printed
• False - No can't be printed

This flag determines whether the order acknowledgment document may be reprinted.

• True - Yes can be reprinted
• False - No can't be reprinted

This flag determines whether a dispatch note can be generated from the sales order.

• True - A dispatch note can be generated from the sales order
• False - A dispatch note can't be generated from the sales order

This is the list of dispatch notes details for the specified sales order and the list of any detail lines for a given order that has not yet been invoiced.

This lists any dispatch notes that were generated for the order.

This is the dispatch note number.

This is the dispatch note status flag.

This is the translated description of the dispatch note status.

This is the dispatch note invoice.

This lists any invoices that have been generated for the sales order.

This is the invoice number.

This is source document from which the invoice was generated.

• O = Sales order

This indicates the description of the invoice source.

• O - Order

• M - Multiple dispatch

• C - Consolidate dispatch

• S - SCT

• T - Dispatch SCT

This is the date when the invoice was last printed.

This indicates the list of formats that can be used to print a sales order document.

This indicates the format details.

This flag determines the sales order document type.

• Invoice
• Delivery Note

This flag determines the sales order format code.

• a - z
• A - Z

This is a description of the format, as supplied by the user.

The XML root node. This includes the option and filter to determine how the document should be generated.

These are the options used to determine how the statement is generated.

This indicates the filter selection. A combination of the filters should equate to a single document.

This is the sales order number filter.

• Filter type S - single

This is the invoice number used to reprint a single invoice.

This is currently not applicable.

This is the dispatch note number filter.

• Filter type S - single

This is the date the document was captured.

This is the document type, which can be one of the following:

• D - Delivery note
• I - Invoice
• O - Acknowledgement
• N - Dispatch Note

This is the format of the document, which can be one of the following:

• 0 - 9
• A - Z
• a - z

This is the print function:

• ONLINE - synchronously generates a single document

This translates foreign text and notes for multi-language option.

This flag determines whether the invoice may be reprinted.

• Y - reprint

This is currently not applicable.

This indicates the selected format options details and the configuration against the template assigned to the format.

This flag is returned by the GETFMTS function.

This is the SRS Document Type.

• Invoice
• get other document types...

This is the Format code that is returned by the GETFMTDET function call.

This is the index to the document entry in the document print control file that is returned by the GETFMTDET function call.

This is the document descriptionthat is returned by the GETFMTDET function call.

Name of the schema file used by the document that is returned by the GETFMTDET function call.

This is the path to the schema file on the application server that is returned by the GETFMTDET function call.

This is the name of the template file used by the document that is returned by the GETFMTDET function call.

This is the path to the template file on the application server that is returned by the GETFMTDET function call.

These are the internal print flags.

This is the custom email subject line.

This is the custom print file name.

This lets you select to use the SQL driver instead of the XML driver.

• True - Use SQL driver
• False - Use XML driver

This is the name of the first printer defined against the document.

This is the number of copies that will be printed.

This lets you collate print copies.

• True - Collate copies
• False - Don't collate copies

This is the document format description from the format control record.

The XML root element. This includes the option and filter to determine how the document should be generated.

This indicates the options used to determine how the statement should be generated

This indicates the filter selection.

Filters should equate to a single document, and currently there is one filter selection which is a customer.

This indicates the customer for whom statements are printed.

This Indicates the business object function to be performed.

Currently ONLINE is the only function available.

This is the document format code.

This defines the financial period for which the statement will be printed.

• C - Current
• P - Previous period 1
• 2 - Previous period 2

If no value is supplied, a default of 'C - Current' will be used.

This is the ageing date that will be applied to the transactions.

The date will default to the relevant ageing date as per the StatementAsOf option supplied, i.e.

• If either P - Previous period or 2 - Previous period 2 is set, the ageing dates for these periods will be applied.
• If this is set to C - Current period, the date will default to the company date.
• A manually entered date overwrites any default dates.

This indicates what ageing method should be applied when ageing transactions.

• S - Statement
• A - Aged statement
• I - Invoice date
• D - Invoice due date

If no value is supplied, the ageing option defined in the AR setup program will be used.

This indicates whether to list invoices for attached sub-account customers when printing statements for master account customer.

This indicates whether statements are printed for sub-account customers.

If you select Y – Yes at IncludeAttached and ConsolidateSub, the invoices for the attached sub-account customers are printed twice - once on the statement for the master account and once on the statement for the sub-account.

This is assuming that both the master and sub-account customer numbers are included in the range of customers for which statements must be printed.

• Y - Yes - prints statement for balance brought forward customer as if it were open-item. i.e. all unpaid invoices are listed on the statement.
• N - No - statements for balance forward customer are printed with a brought forward total followed by only current invoices being listed.

This indicates whether customer with certain balances should be included.

• A - All
• D - Debit
• C - Credit

If no value is supplied then a default value of A - All will be used.

This indicates the amount which a customer's balance must exceed before a statement is printed.

A message of up to 50 characters that you want printed on the statement.

This indicates that the specified purchase order can be printer based on the purchase order status.

• True - the selected purchase order is ready to be printed.

This indicates that the specified purchase order can be re-printed based on whether the purchase order has been printed.

• True - the purchase order has been printed and can now be reprinted.

The XML root element.

This is the XML tag which includes the selected purchase order details including the status of the purchase order and the list of formats that can be used when printing a purchase order.

SRS Document Type, e.g.

• L - Purchase Orders - Local

• F - Purchase Orders - Foreign

• R - Purchase Orders - Requisitions

• C - Blanket Contract

This is the description of the SRS Document type.

• Purchase Orders - Local

This is the code for the document format.

Document format name.

• P/order - Local

This indicates the list of the formats that can be used to print a purchase order.

This includes the document type (purchase order foreign or local) and the format codes per document type.

This indicates the purchase order key to be printer.

This indicates whether the purchase order status is active.

This indicates whether the purchase order status is cancelled.

This indicates the status of the purchase order.

This indicates the code of the purchase order type.

This • indicates the description for the order status.

• 0 - In process

• 1 - Ready to print

• 4 - Order printed

• 9 - Completed

• * - Cancelled

This indicates the description of the order type.

• L - Local

• I - Import

• O - Other

Print function. 'ONLINE' - synchronously generate a single document.

This indicates the purchase order document type.

• L - Purchase Orders - Local
• F - Purchase Orders - Foreign
• R - Purchase Orders - Requisitions
• C - Blanket Contract

This indicates the purchase order Format code.

• 0 - 9
• A - Z.

This is required for the GETFMTS function only.

This is reprint flag.

• Y - reprint a quotation

This indicates the filter selection for the order to be printed.

Filter selection ensures a single purchase order is printed.

This is the purchase order number filter.

• Filter Type 'S' - single

This indicates that the specified quotation can be printer based on the purchase order status.

• True - the selected quotation is ready to be printed.

This indicates that the specified quotation can be re-printed based on whether the quotation has been printed.

• True - the quotation has been printed and can now be reprinted.

The XML root node.

The XML tag which includes the selected quotation details including the status of the quotation and the list of formats that can be used when printing a quotation.

This indicates the quotation to be printed.

This indicates the version number of the specified quotation.

This indicates the status of the specified quotation.

This indicates the description of the quotation status.

• 0 - In progress

• 1 - Ready for printing

• 2 - Printed

• 4 - Confirmed

• H - On hold

• R - Rejected

• S - Superseded - new version

• \ - Cancelled

This is the date of the document.

This indicates the filter selection for the quotation to be printed.

Filter selection ensures a single quotation.

This indicates the quotation to be printed.

This is the print function.

• ONLINE - synchronously generate a single document.

This lets you print the default offer.

• D - Print
• N - Do not print

This lets you print offer number 1.

• 1 - Print

• N - Do not print

This lets you print offer number 2.

• 2 - Print

• N - Do not print

This lets you print offer number 3.

• 3 - Print

• N - Do not print

This lets you print offer number 4.

• 4 - Print

• N - Do not print

This lets you print offer number 5.

• 5 - Print

• N - Do not print

This is the quotation number filter type.

• S - single

This is the reprint flag.

• Y - reprint a quotation

This is the custom print file name.

This is the custom email subject line.

The XML root.

The XML tag which includes the selected job details including the status of the job and the list of formats that can be used when printing a job.

Description against the document in the document print control files that is returned by the GETFMTDET function.

This is the index to the document record in the document print control files that that is returned by the GETFMTDET function.

SRS Document Type.

• Quotation - Single

This indicates the document number according to which the job(s) must be printed.

This indicates the document format within the document number according to which the job must be printed.

These are PDF encryption details that are used by the process generating the PDF to encrypt the document if it is set against the format being used.

Print copies collated.

• True
• False

This is the number of copies to print.

Name of the first printer defined against the document

Schema file name - without path - used by the document type that is returned by the GETFMTDET function.

Full path to the schema used by the document type that is returned by the GETFMTDET function.

This is the Crystal RPT file name - without path - that used by the document and returned by the GETFMTDET function.

This is the full path to the Crystal RPT used by the document and returned by the GETFMTDET function.

Use SQL driver instead of XML driver

• True
• False

This is the document number according to which the job(s) must be printed.

• 1 - 4

This indicates the job for which the XML/document is generated.

The filter type is always single and filter value is Job.

This is the job filter type.

• S - single

This is the document format.

• 0 - 9
• A - Z

This indicates the options used to determine how the job should be generated and further filters using the state of the job.

The XML root element.

This includes the option and filter to determine how the document should be generated.