R1.4.0.0 September 26, 2024 release notes
ONESOURCE E-Invoicing API updates
The latest update to the Swagger Open API Specification (v1.4.0) includes new optional fields and enhancements to existing fields.
New optional fields
New optional fields have been added at both the document and document line levels.
- Document level
- accountingSupplierParty ->customerAssignedAccountId
- accountingSupplierParty ->party->persons
- accountingCustomerParty ->supplierAssignedAccountId
- accountingSupplierParty ->accountingContact ->name
- accountingCustomerParty ->party->persons
- accountingCustomerParty ->accountingContact ->name
- buyerCustomerParty ->party->persons
- buyerCustomerParty ->accountingContact ->name
- deliveries ->despatchParty ->contact
- paymentMeans ->payeeFinancialAccount ->currencyCode
- paymentMeans ->payeeFinancialAccount ->financialInstitutionBranch ->address
- withholdingTaxTotal
- Document line level
- documentLines ->withholdingTaxTotal
Field updates
Several fields at both the document and line levels have been updated from object format to list format. The current object format will be deprecated in future releases.
- Document levelObjectListaccountingSupplierParty ->party->partyIdentificationIdaccountingSupplierParty ->party->partyIdentificationIdsaccountingCustomerParty ->party->partyIdentificationIdaccountingCustomerParty ->party->partyIdentificationIdspayeeParty ->partyIdentificationIdpayeeParty ->partyIdentificationIdsbuyerCustomerParty ->party->partyIdentificationIdbuyerCustomerParty ->party->partyIdentificationIdstaxRepresentativeParty ->party->partyIdentificationIdtaxRepresentativeParty ->party->partyIdentificationIdsdeliveries ->deliveryParty ->partyIdentificationIddeliveries ->deliveryParty ->partyIdentificationIdsdeliveryTerms ->specialTermsdeliveryTerms ->specialTermsListdeliveryTerms ->lossRiskdeliveryTerms ->lossRiskspaymentMeans ->paymentIdpaymentMeans ->paymentIds
- Document line levelObjectListdocumentLines ->item->manufacturersItemIddocumentLines ->item->manufacturersItemIds
Path updates for existing fields
New optional extension fields have been added in Swagger at both the document and line levels. Additionally, the paths for some existing extension fields have been updated within the API to improve compatibility with future updates.
note
While backward compatibility is maintained, new implementations should use the updated paths. If values are provided in both the old and new paths, the old path will take precedence.
Field | Old path (Current path) | New path |
|---|---|---|
registrationData | accountingSupplierParty -> party ->registrationData | accountingSupplierParty -> party ->partyExtension ->registrationData |
dutyStamp | dutyStamp | DocumentExtensions ->dutyStamp |
Document level - taxChargeability | taxTotals -> taxSubtotals -> taxChargeability | taxTotals -> taxSubtotals -> taxSubtotalExtension -> taxChargeability |
Line level - taxChargeability | documentLines -> taxTotals -> taxSubtotals -> taxChargeability | documentLines -> taxTotals -> taxSubtotals -> taxSubtotalExtension -> taxChargeability |
New optional extension fields
New optional extension fields have been added at both the document and line levels.
- Document level
- restrictedInformation: documentExtensions -> restrictedInformation
- restrictedInformationLine: documentExtensions -> restrictedInformationLine
- classification: documentExtensions -> classification
- invoiceSeries: documentExtensions -> invoiceSeries
- supplyType: documentExtensions -> supplyType
- languageCode: documentExtensions -> languageCode
- iGSTOnIntra: documentExtensions -> iGSTOnIntra
- billingSoftware: documentExtensions -> billingSoftware
- supplierGeneratedQRString: documentExtensions -> supplierGeneratedQRString
- orderReferenceExtension: orderReference -> orderReferenceExtension
- deliveryExtension: deliveries -> deliveryExtension
- paymentTermsExtension: paymentTerms -> paymentTermsExtension
- prepaidPaymentExtension: prepaidPayment -> prepaidPayment
- taxSubtotalExtension: taxTotals ->taxSubtotals -> taxSubtotalExtension
- legalMonetaryTotalExtension: legalMonetaryTotal -> legalMonetaryTotalExtension
- billingReferenceExtension: billingReferences -> billingReferenceExtension
- contractDocumentReferenceExtension: contractDocumentReferences -> contractDocumentReferenceExtension
- partyExtension: accountingSupplierParty -> party -> partyExtension
- partyExtension: accountingCustomerParty -> party ->partyExtension
- partyExtension: deliveries -> Delivery -> deliveryParty -> partyExtension
- partyExtension: buyerCustomerParty -> party -> partyExtension
- Document Line Level
- restrictedInformation: documentLine ->lineExtension -> restrictedInformation
- taxCurrencyLineExtensionAmount: documentLine ->lineExtension -> taxCurrencyLineExtensionAmount
- taxInclusiveLineExtensionAmount: documentLine ->lineExtension -> taxInclusiveLineExtensionAmount
- taxCurrencyTaxInclusiveLineExtensionAmount: documentLine ->lineExtension -> taxCurrencyTaxInclusiveLineExtensionAmount
- originatorDocumentReference: documentLine ->lineExtension -> originatorDocumentReference
- projectReference: documentLine ->lineExtension -> projectReference
- orderLineReferenceExtension: documentLine -> orderLineReferences -> orderLineReference -> orderLineReferenceExtension
- contractDocumentReference: documentLine ->lineExtension -> contractDocumentReference
- itemExtension: documentLine -> item -> itemExtension
- priceExtension: documentLine -> price -> priceExtension
ONESOURCE E-Invoicing application updates
Enhanced handling of negative values in Credit Notes for AP invoices
Previously, when customers submitted a Credit Note with a negative value while sending an accounts payable (AP) invoice, the system would return an empty
documentLine
, preventing users from viewing the associated line-item details.We've resolved this issue and the system now processes negative values in credit notes, ensuring that users can access and view the complete line item details within the
documentLine
field when sending AP invoices.Fix details:
- Negative values in Credit Notes: Negative values in Credit Notes are now fully supported when sending AP invoices.
- Document line items: Users can now view the completedocumentLinedetails, including all associated line items, when submitting an AP invoice with a negative Credit Note.
- Improved functionality: The fix ensures that Credit Notes with negative values are processed without any loss of document line-item details.
Display of Target XML as PDF format in Document Grid Preview
The Target XML file is now displayed in PDF format in the
Document Grid Preview
page. When the Distribution field is set to NONE
in the document API response, the target XML file will now be rendered in PDF format within the document grid’s preview section. This enhancement ensures that users can view the relevant target file in a readable format.Key updates:
- Document Grid Preview: When the distribution status in the backend API response is set toNONE, the target XML file, previously not available for display, will now appear as a PDF in the preview section.
- Improved accessibility: Users will no longer encounter issues with missing or unviewable target XML files. The system converts the XML into a readable PDF format for easy access.
This update ensures a more intuitive and streamlined document preview experience in cases where no XML file applies.
Support for Italy AP invoices source XML file in local format as attachments in UI and API
This update introduces the ability to download Italy AP source XML file in Local format as attachments directly from the Document Page in the UI, as well as via the API.
UI enhancements:
- Document page: The Action section now includes a download subsection displaying all available attachments related to the document.
- Italy AP invoice Local format XML attachments are clearly distinguished from other attachments for easy identification.
- ADownloadoption has been added to enable users to download the AP Local format XML attachment directly from the UI.
API support:
Italy AP invoice Local format XML attachments are now fully supported for download via the API.
ONESOURCE E-Invoicing user interface enhancement
- TheClearance IDis now displayed in the Government ID column of the document grid for all AP invoices, letting users easily view theClearance IDwithin the AP invoice Peppol target XML and in the UI grid.
- TheCustomer Namedisplayed in the grid on theCompaniespage has been replaced withCompany Name. This update is also reflected in filters and Excel exports for consistency.
- A newCompany IDcolumn has been added to the Companies page grid, positioned betweenCompany NameandCompany Number. Additionally, theCustomer Numbercolumn has been renamed toCompany Number, and these changes are also reflected in Excel exports.
- The field currently labeled asVAT Numberin the company details view has been renamed toTIN (Tax Identification Number). This update aims to use a more globally recognized term for better understanding. The new label will be consistently applied throughout the UI wherever company details are displayed, ensuring clarity for all users.
- SELF-BILLEDhas been added as a document sub-type in the document grid, letting users easily identify and manage self-billing documents. This enhancement includes the ability to filter, sort, and search forSELF-BILLEDdocuments, ensuring accurate data integrity and an intuitive user interface while maintaining proper access permissions.