The generalInvoiceResponse ATL COM module loads &
analyzes electronic responses to general invoice requests
analyzes electronic responses to general invoice requests
API browser of generalInvoiceResponse450 COM module
IGeneralInvoiceResponse::GetCredit method | |||
---|---|---|---|
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". |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralInvoiceResponse/GetCredit | ||
[JSON input data] | pIGeneralInvoiceResponse: | longValue, //interface address |
|
[JSON result data] | pbstrRequestCreditID: pdRequestCreditDate: plRequestCreditTimestamp: 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. | ||
C/C++ calling syntax | |||
HRESULT GetCredit( | BSTR
DATE long VARIANT_BOOL |
*pbstrRequestCreditID,
*pdRequestCreditDate, *plRequestCreditTimestamp, *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. | ||
Calling argument 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 | |