GET api/Gadget/GetReceivedDocuments?MyAccountId={MyAccountId}&FromDate={FromDate}&ToDate={ToDate}&DocumentTypeId={DocumentTypeId}&SenderCode={SenderCode}&Number={Number}&Page={Page}&ReadMode={ReadMode}
Return the list of received documents where the account has access to.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
MyAccountId | globally unique identifier |
Required |
|
FromDate | date |
Required |
|
ToDate | date |
Required |
|
DocumentTypeId | integer |
Required |
|
SenderCode | string |
Required |
|
Number | integer |
Required |
|
Page | integer |
Default value is 1 |
|
ReadMode | string |
Default value is All |
Body Parameters
None.
Response Information
Resource Description
Collection of DocumentName | Description | Type | Additional information |
---|---|---|---|
DocumentId | globally unique identifier |
None. |
|
SenderId | globally unique identifier |
None. |
|
ReceiverId | globally unique identifier |
None. |
|
DocumentTypeId | integer |
None. |
|
DocumentTypeName | string |
None. |
|
Number | integer |
None. |
|
Series | string |
None. |
|
SenderCode | string |
None. |
|
SenderName | string |
None. |
|
ReceiverCode | string |
None. |
|
ReceiverName | string |
None. |
|
Date | date |
None. |
|
NetAmount | decimal number |
None. |
|
TaxAmount | decimal number |
None. |
|
FreeAmount | decimal number |
None. |
|
TotalAmount | decimal number |
None. |
|
CurrencyTypeId | integer |
None. |
|
CurrencyTypeName | string |
None. |
|
HasOffers | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "DocumentId": "35391ab3-76f3-429e-bad9-8bb84aa74980", "SenderId": "9ec34523-e4ea-4769-9331-fcfc4a7ff612", "ReceiverId": "6004ac44-b1f6-496e-9e19-46eda4f048c0", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2024-05-08T03:33:58.2244797+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17", "HasOffers": true }, { "DocumentId": "35391ab3-76f3-429e-bad9-8bb84aa74980", "SenderId": "9ec34523-e4ea-4769-9331-fcfc4a7ff612", "ReceiverId": "6004ac44-b1f6-496e-9e19-46eda4f048c0", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2024-05-08T03:33:58.2244797+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17", "HasOffers": true } ]
application/xml, text/xml
Sample:
<ArrayOfDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gosocket.SDK.Domain"> <Document> <_x003C_CurrencyTypeId_x003E_k__BackingField>1</_x003C_CurrencyTypeId_x003E_k__BackingField> <_x003C_CurrencyTypeName_x003E_k__BackingField>sample string 17</_x003C_CurrencyTypeName_x003E_k__BackingField> <_x003C_Date_x003E_k__BackingField>2024-05-08T03:33:58.2244797+00:00</_x003C_Date_x003E_k__BackingField> <_x003C_DocumentId_x003E_k__BackingField>35391ab3-76f3-429e-bad9-8bb84aa74980</_x003C_DocumentId_x003E_k__BackingField> <_x003C_DocumentTypeId_x003E_k__BackingField>4</_x003C_DocumentTypeId_x003E_k__BackingField> <_x003C_DocumentTypeName_x003E_k__BackingField>sample string 5</_x003C_DocumentTypeName_x003E_k__BackingField> <_x003C_FreeAmount_x003E_k__BackingField>15</_x003C_FreeAmount_x003E_k__BackingField> <_x003C_HasOffers_x003E_k__BackingField>true</_x003C_HasOffers_x003E_k__BackingField> <_x003C_NetAmount_x003E_k__BackingField>13</_x003C_NetAmount_x003E_k__BackingField> <_x003C_Number_x003E_k__BackingField>6</_x003C_Number_x003E_k__BackingField> <_x003C_ReceiverCode_x003E_k__BackingField>sample string 10</_x003C_ReceiverCode_x003E_k__BackingField> <_x003C_ReceiverId_x003E_k__BackingField>6004ac44-b1f6-496e-9e19-46eda4f048c0</_x003C_ReceiverId_x003E_k__BackingField> <_x003C_ReceiverName_x003E_k__BackingField>sample string 11</_x003C_ReceiverName_x003E_k__BackingField> <_x003C_SenderCode_x003E_k__BackingField>sample string 8</_x003C_SenderCode_x003E_k__BackingField> <_x003C_SenderId_x003E_k__BackingField>9ec34523-e4ea-4769-9331-fcfc4a7ff612</_x003C_SenderId_x003E_k__BackingField> <_x003C_SenderName_x003E_k__BackingField>sample string 9</_x003C_SenderName_x003E_k__BackingField> <_x003C_Series_x003E_k__BackingField>sample string 7</_x003C_Series_x003E_k__BackingField> <_x003C_TaxAmount_x003E_k__BackingField>14</_x003C_TaxAmount_x003E_k__BackingField> <_x003C_TotalAmount_x003E_k__BackingField>16</_x003C_TotalAmount_x003E_k__BackingField> </Document> <Document> <_x003C_CurrencyTypeId_x003E_k__BackingField>1</_x003C_CurrencyTypeId_x003E_k__BackingField> <_x003C_CurrencyTypeName_x003E_k__BackingField>sample string 17</_x003C_CurrencyTypeName_x003E_k__BackingField> <_x003C_Date_x003E_k__BackingField>2024-05-08T03:33:58.2244797+00:00</_x003C_Date_x003E_k__BackingField> <_x003C_DocumentId_x003E_k__BackingField>35391ab3-76f3-429e-bad9-8bb84aa74980</_x003C_DocumentId_x003E_k__BackingField> <_x003C_DocumentTypeId_x003E_k__BackingField>4</_x003C_DocumentTypeId_x003E_k__BackingField> <_x003C_DocumentTypeName_x003E_k__BackingField>sample string 5</_x003C_DocumentTypeName_x003E_k__BackingField> <_x003C_FreeAmount_x003E_k__BackingField>15</_x003C_FreeAmount_x003E_k__BackingField> <_x003C_HasOffers_x003E_k__BackingField>true</_x003C_HasOffers_x003E_k__BackingField> <_x003C_NetAmount_x003E_k__BackingField>13</_x003C_NetAmount_x003E_k__BackingField> <_x003C_Number_x003E_k__BackingField>6</_x003C_Number_x003E_k__BackingField> <_x003C_ReceiverCode_x003E_k__BackingField>sample string 10</_x003C_ReceiverCode_x003E_k__BackingField> <_x003C_ReceiverId_x003E_k__BackingField>6004ac44-b1f6-496e-9e19-46eda4f048c0</_x003C_ReceiverId_x003E_k__BackingField> <_x003C_ReceiverName_x003E_k__BackingField>sample string 11</_x003C_ReceiverName_x003E_k__BackingField> <_x003C_SenderCode_x003E_k__BackingField>sample string 8</_x003C_SenderCode_x003E_k__BackingField> <_x003C_SenderId_x003E_k__BackingField>9ec34523-e4ea-4769-9331-fcfc4a7ff612</_x003C_SenderId_x003E_k__BackingField> <_x003C_SenderName_x003E_k__BackingField>sample string 9</_x003C_SenderName_x003E_k__BackingField> <_x003C_Series_x003E_k__BackingField>sample string 7</_x003C_Series_x003E_k__BackingField> <_x003C_TaxAmount_x003E_k__BackingField>14</_x003C_TaxAmount_x003E_k__BackingField> <_x003C_TotalAmount_x003E_k__BackingField>16</_x003C_TotalAmount_x003E_k__BackingField> </Document> </ArrayOfDocument>