generalInvoiceResponse - the COM module for
loading and analyzing invoice XML responses
generalInvoiceResponse
    API DocBrowser   ·  Revision history
    Download area
    FAQ
 
home
system
integrators
search the
site
 

validator
modules
invoice
modules
credit
modules
miscellaneous
modules
tools

  Design by TMR AG
  © by sumex1.net
 
IGeneralInvoiceResponse::GetCredit method

 Description  V4.30/26 Aug 2010 
Retrieves the optional credit object reference parameters. In fact this object reference is mirrored from the corresponding invoice/reminder request infoset.

The credit, invoice and reminder object references (if supplied in the request) form a object reference chain (credit -> invoice -> reminder) with the reminder as topmost object reference if supplied in the request otherwise the invoice is the topmost object reference (the invoice object is mandatory in all cases!). The page "object reference" provides an in-depth description of the concepts of "object reference", "object reference chain", and "topmost object reference".

If the data stem from loading a lower version XML file, then a compatibility error is issued! If full support is needed for a lower version then there is not resort than using the native COM versions directly.

 C/C++ syntax
HRESULT  GetCredit( BSTR   *pbstrRequestCreditID,
DATE   *pdRequestCreditDate,
long   *plRequestCreditTimestamp,
VARIANT_BOOL   *pbStatus);

 Parameter description
[out]   BSTR   *pbstrRequestCreditID   The request ID is the main software's identification of the credit ("Kostengutsprachenummer") - mirrored from the request.

This is one of 3 identifiers that form the credit object reference.

[out]   DATE   *pdRequestCreditDate   The request date is the main software's date of the credit request ("Kostengutsprachedatum") - mirrored from the request.

This is one of 3 identifiers that form the credit object reference.

[out]   long   *plRequestCreditTimestamp   This is a UNIX timestamp defined at the moment of the credit's infoset generation - mirrored from the request.

This is one of 3 identifiers that form the credit object reference.

[out, retval]   VARIANT_BOOL   *pbStatus   Return status of the method. If pbStatus is VARIANT_FALSE then no credit object reference was defined

 C/C++ return value
S_OK This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE.
S_FALSE This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE.
E_name This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions.
generalInvoiceResponse
  IGeneralInvoiceResponse
    GetCredit