gtAPCreditNote

Provides the information needed to create an Accounts Payable Credit Note header. This header must exist before you can add credit note line items to it. The function returns a unique identifier used to link the associated line items.

Each Accounts Payable Credit Note is uploaded to Greentree Desktop as a complete transaction set. The Credit Note either uploads in its entirety or nothing of the document is loaded into Greentree Desktop.

The unique identifier returned by the function call is structured as APCN-nnn if nnn is a sequential number that is unique for the current Excel session. This number links the AP Credit Note line item function calls with its header call.

Company

The code for the company in which Greentree Desktop generates the credit note.

Batch

The batch number the credit note is to be posted in. A new batch is created if it does not exist.

BatchDesc

The description if a new batch is created. This is ignored if the batch already exists. An error returns if the batch description is null and the batch does not exit.

Branch

The branch identifier.

Reference

The supplier's credit note number. A credit note with this number cannot already exist for the Supplier or an error is returned.

Supplier

The supplier code for the transaction.

DocumentDate

The document date for the credit note entry.

PostingDate

The posting date for the credit note entry. This determines the financial period the transactions post to.

PaymentDate

Date the credit note is due for payment. If this date is left blank, the payment date is calculated from the supplier's payment terms.

Narration

Narration for the credit note header.

CurrencyRate

The exchange rate for a foreign currency transaction.

MultiplyRate

Defaults to True. If true the rate above is a multiply rate rather than a divide rate.

IsWithldTax

Defaults to False. Indicates if this credit note is subject to withholding tax on payment.

ForceWthhldTax

The default value is False. Indicates if this credit note is subject to withholding tax on payment regardless of the Supplier default on withholding tax.

Returns

Unique identifier.

Errors Returned

Must have a Company Identifier
Must have a Batch Identifier
Must have a Branch Identifier
Must have a Credit Note Reference
Must have a Supplier Number
Must have a Document Date
Must have a Posting Date
Invalid Payment Date
Invalid Narration, must be a string or omitted
Invalid Currency Rate, must be a number or omitted
Invalid MultplyRate, must be True, False or omitted
Invalid IsWthhldTax, must be True, False or omitted
Invalid ForceWthhldTax, must be True, False or omitted