POST api/BackOffice/HandleGetInvoices
Receove request to get invoice
Request Information
URI Parameters
None.
Body Parameters
GetInvoicesRequestName | Description | Type | Additional information |
---|---|---|---|
InvoiceNumber | string |
Required |
|
PlainText | string |
Required |
|
UserName |
The provided user name. |
string |
Required |
Salt |
A random number(at least 9 digits) |
integer |
Required |
Digest |
A digest of the user credentials and the request |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "InvoiceNumber": "sample string 1", "PlainText": "sample string 2", "UserName": "sample string 3", "Salt": 4, "Digest": "sample string 5" }
application/xml, text/xml
Sample:
<GetInvoicesRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="sample string 3" Salt="4" Digest="sample string 5" InvoiceNumber="sample string 1" PlainText="sample string 2" />
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
returns invoice object
GetInvoiceResponseName | Description | Type | Additional information |
---|---|---|---|
string |
None. |
||
Success |
Indicate if the operation was success |
boolean |
None. |
Message |
Return of errors or indicated return message/data |
string |
None. |
Extra1 |
Additional info 1 to return |
string |
None. |
Extra2 |
Additional info 2 to return |
string |
None. |
Extra3 |
Additional info 3 to return |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "PDF": "sample string 1", "Success": true, "Message": "sample string 3", "Extra1": "sample string 4", "Extra2": "sample string 5", "Extra3": "sample string 6" }
application/xml, text/xml
Sample:
<GetInvoiceResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" PDF="sample string 1"> <Success>true</Success> <Message>sample string 3</Message> <Extra1>sample string 4</Extra1> <Extra2>sample string 5</Extra2> <Extra3>sample string 6</Extra3> </GetInvoiceResponse>