Importing receipts from an XML file
Overview
Receipts can be imported into an Accentis Enterprise database using an XML file. External systems can produce this file in the Accentis Enterprise format, or you can have an importer written to suit your external format.
Once you have an XML file, all you need to do is drag and drop it onto the Accentis Enterprise main (toolbar) window. The file will be read and receipts will be automatically created with invoice allocations per your import file.
General XML information
- Data contained within an XML file must confirm to standard XML formatting
- A single XML file can contain multiple record specifications within their own “AccentisImport” key
- It is possible to include multiple lines for each record in an XML file. See below for details.
Remittance XML specific information
- Importing a Remittance XML record into an Accentis Enterprise system will generate a Receipt within Accentis Enterprise.
File Structure
<AccentisFile>
<AccentisImport Type="Remittance">
<Remittance>
<Sender>NAME</Sender>
<Recipient>NAME</Recipient>
<Currency>CURRENCYCODE</Currency>
<PaymentMethod>PAYMENTTYPE</PaymentMethod>
<PaymentAmount>AMT</PaymentAmount>
<RemittanceAmount>AMT</RemittanceAmount>
<WithheldAmount>AMT</WithheldAmount>
<RemittanceDate>DATE</RemittanceDate>
<Reference>REFERENCE</Reference>
<Notes>NOTES</Notes>
</Remittance>
<Invoices>
<Invoice Amount="AMT" Currency="CURRENCYCODE" Number="INVOICE#"/>
<Invoice Amount="AMT" AmountDiscount="AMT" AmountNett="AMT" Currency="CURRENCYCODE" Number="INVOICE#"/>
</Invoices>
</AccentisImport>
</AccentisFile>
File Structure Definitions
Field name | Data example | Data definition |
<AccentisFile> | - | Mandatory file header. This line should only appear once in each file. |
<AccentisImport Type= | Remittance | Mandatory import identifier that specifies the import type. This is a fixed string. This line should appear as the first line for each remittance record included in the file. |
<Remittance> | - | Mandatory record body identifier. This line must appear once for each remittance record included in the file. |
<Sender> | BUNNINGS | External record indicator. When imported into an Accentis Enterprise system, this data will populate the Customer field on the receipt. If the data matches a customer code, that code will be used. If not, it will be treated as a customer name. |
<Recipient> | ABC furnishings | Internal record indicator. This field is not used when importing an XML file but is included for compatibility. |
<Currency> | AUD | Indicates the currency in which values in the file are expressed. |
<PaymentMethod> | CHEQUE | The payment method used by the remittance. This element is not required. This element supports values of CHEQUE and EFT. Other values will result in EFT being used. |
<PaymentAmount> | 999.99 | The total payment amount of the remittance. This field is not used when importing an XML file but is included for compatibility. |
<RemittanceAmount> | 999.99 | The total amount being remitted. This value is used to populate the Amount field on the Receipt. |
<WithheldAmount> | 999.99 | The total amount withheld as part of the remittance. This field is not used when importing an XML file but is included for compatibility. |
<RemittanceDate> | 2016-08-16 | The date on which the remittance was performed. This value is used to populate the Date field on the Receipt. |
<Reference> | Free text | External reference indicator. This field is not used when importing an XML file but is included for compatibility. |
<Notes> | Free text | Note relating to the Remittance. This field is not required, but if specified will be used to populate the Memo field on the Receipt. |
<Invoices> | - | Mandatory record lines identifier. This line must appear once for each remittance record included in the file. |
<Invoice | Number="98765"
Amount="999.99" AmountDiscount="0.00" AmountNett="999.99" Currency="AUD" |
Identifies a single invoice included as part of the remittance.
When imported into an Accentis Enterprise System, each <Invoice line included will populate a separate invoice line in the Receipt. Each <invoice line MUST contain an Amount, Currency and Number specifier and can also contain an AmountDiscount and/or AmountNett specifier. Each specifier must be directly followed by an = and a value encased in double quotes. Specifiers must be separated by a single space. When imported, the specifiers will be used to populate the following invoice line fields: Number - Valid Sales Invoice number within Accentis Enterprise Amount - The amount applied for the Invoice AmountDiscount - The discount amount for the Invoice AmountNett - The Nett amount for the Invoice Currency - The currency in which values |
Repeat the <Invoice field above for each required record line | - |