API browser of generalInvoiceRequest450 COM module


/images/arrow_right.png IGeneralInvoiceRequest::SetCredit method space
Sets the optional credit object reference parameters. This object reference is only set if such a credit request was generated and accepted prior to the invoice generation.
 
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".
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceRequest/SetCredit
[JSON input data] pIGeneralInvoiceRequest:
bstrRequestCreditID:
dRequestCreditDate:
lRequestCreditTimestamp:
longValue,    //interface address
"utf8StringValue",
variantDateValue | "stringISODateValue",
longValue
[JSON result data] pbStatus: 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 SetCredit( BSTR
DATE
long
VARIANT_BOOL
bstrRequestCreditID,
dRequestCreditDate,
lRequestCreditTimestamp,
*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
[in] BSTR bstrRequestCreditID The request ID is the main software's identification of the credit ("Kostengutsprachenummer").
 
This is one of 3 identifiers that form the credit object reference.
[in] DATE dRequestCreditDate The request date is the main software's date of the credit request ("Kostengutsprachedatum").
 
This is one of 3 identifiers that form the credit object reference.
[in] long lRequestCreditTimestamp This is a UNIX timestamp defined at the moment of the credit's infoset generation.
 
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 an error occurred and GetAbortInfo should be called to retrieve the error string.
space