Vendor Credit

The following sample vendor credit e-document template and custom data source plug-in implementation must be used with the vendor credit template. You must do this to successfully convert PEPPOL XML file into a vendor credit transaction.

  1. Inbound Vendor Credit Template

    File Name: Inbound_VendorCredit_peppol_template.txt

    Location: Bundle 436209/Sample Templates

  2. Custom Data Source Plug-in (Vendor Credit)

    File Name: pl_custom_data_source_vendor_credit.js

    Location: Bundle 436209/src/comp/pl

    Plug-in Implementation name: Vendor Credit Inbound CDS

Note:

To use the templates, paste the content into the "Field Mapping for Inbound E-Document" field of the new E-Document Template creation page.

Select the transaction type as bill credit. In the template, in create mode, select Vendor Credit Inbound CDS from the Inbound Custom Data Source Plug-in Implementation list.

Limitations:

Follow the below table for mapping details:

S.NO

JSON Key in Template

XML element applied from XML reference

Information for the Key

1

tranid

D:CreditNote/cbc:ID

This key uniquely identifies the Vendor Bill, that is, Reference Number.

2

trandate

D:CreditNote/cbc:IssueDate

This key displays the issue date of the bill credit provided by the vendor, that is, Date. The date is in the format of the system preferences set in the account.

If the element cbc:IssueDate is missing in the XML reference file, it will throw an error "The issue date XPath for the transaction could not be found in the XML reference file."

If the value of the cbc:IssueDate element in XML Reference file is not in the format YYYY-MM-DD, it will throw an error "The issue date of the transaction in the XML reference file is not in correct format.".

3

duedate

D:CreditNote/cbc:DueDate

This key displays the payment due date. The date is in the format of the system preferences set in the account. The Bill will be populated only if the XML Reference has relevant value.

If the value of the cbc:DueDate element in XML Reference file is not in the format YYYY-MM-DD, you get the error "The due date of the transaction in the XML reference file is in invalid format."

4

memo

D:CreditNote/cbc:Note

This element displays unstructured note related to the bill credit. The bill credit will be populated only if the XML Reference has relevant value.

5

currency

D:CreditNote/cbc:DocumentCurrencyCode

This key displays the currency name in bill credit. The value of this field is derived from the Custom Data Source Plug-in (CDS) used in the template. It retrieves currency name from the Currency ISO code present in the XML Reference. Multi Currency feature must be enabled in the account.

6

item

D:CreditNote/cac:CreditNoteLine

This key iterates over all line items in the XML Reference.

7

vendorcode

D:CreditNote/cac:CreditNoteLine/cac:Item/cbc:Name

This key displays vendor code that is same as the item name. It does not support any other reference apart from item name. Check Limitations section for more details.

8

vendorname

D:CreditNote/cac:CreditNoteLine/cac:Item/cbc:Name

This key displays vendor name that is same as the item name.

9

quantity

D:CreditNote/cac:CreditNoteLine/cac:Item /cbc:CreditedQuantity

This key displays quantity of each line item. Quantity is not added if the quantity of each line item is not present in the XML Reference.

The element value with a decimal separator (.) or a whole number is valid. Group separator (Thousands separator) or more than one decimal separator is invalid.

10

rate

D:CreditNote/cac:CreditNoteLine/cac:Item /cac:Price/ cbc:PriceAmount

This key displays net price or unit price of the item. It displays the rate of each line item, exclusive of GST after subtracting item price discount.

The element value with a decimal separator (.) or (,), or a whole number is valid.

Group separator (Thousands separator) or more than one decimal separator is invalid.

11

amount

D:CreditNote/cac:CreditNoteLine/cbc:LineExtensionAmount

The key displays invoice line net amount. The amount is net without GST, that is, inclusiveness of line level allowances and charges along with other relevant taxes.

The element value with a decimal separator (.) or (,), or a whole number is valid. Group separator (Thousands separator) or more than one decimal separator is invalid.

12

location

 

If you have the Locations feature enabled, this field is required in bill credit, although no direct or indirect mapping from vendor XML is done in the template. You have to modify this field according to your business need. Currently, it is being hard coded to Parent Location.

13

description

D:CreditNote/cac:CreditNoteLine/cac:Item/cbc:Name

This key’s description is taken from the item’s name. You can change the reference in the XML reference if needed.

14

inventiorydetailreq

 

This key is a required field for items. The default value is set to False for each item.

15

apply

D:CreditNote/cac:BillingReference

This key iterates over all the invoice references applied in the XML.

16

refnum

D:CreditNote/cac:BillingReference/cac:InvoiceDocumentReference/cbc:ID

 

17

createdFrom

D:CreditNote/cbc:BuyerReference

 

General Notices