API browser of generalInvoiceResponse450 COM module


/images/arrow_right.png IGeneralInvoiceResponse::GetInvoice method space
Retrieves the invoice 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 an 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".

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceResponse/GetInvoice
[JSON input data] pIGeneralInvoiceResponse: longValue,    //interface address
[JSON result data] pbstrRequestInvoiceID:
pdRequestInvoiceDate:
plRequestInvoiceTimestamp:
pbStatus:
"utf8StringValue",
"stringISODateValue",
longValue,
booleanValue
 
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetInvoice( BSTR
DATE
long
VARIANT_BOOL
*pbstrRequestInvoiceID,
*pdRequestInvoiceDate,
*plRequestInvoiceTimestamp,
*pbStatus);
[C/C++ return value] S_OK This value is returned if the function call was successful.
S_FALSE This value is returned if the end of an iteration is reached
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.
space
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrRequestInvoiceID The request ID is the main software's identification of the invoice ("Rechnungsnummer") - mirrored from the request.

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

[out] DATE *pdRequestInvoiceDate The request date is the main software's date of the invoice request ("Rechnungsdatum") - mirrored from the request.

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

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

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

[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
space