GET api/Gadget/GetDocumentAttachments?CountryId={CountryId}&DocumentId={DocumentId}&Date={Date}&Sent={Sent}
Return the list of attachments associated to a specific document.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CountryId | string |
Required |
|
DocumentId | globally unique identifier |
Required |
|
Date | date |
Required |
|
Sent | boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of AttachmentName | Description | Type | Additional information |
---|---|---|---|
AttachmentId | globally unique identifier |
None. |
|
DocumentId | globally unique identifier |
None. |
|
AttachmentTypeId | integer |
None. |
|
AttachmentTypeName | string |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
Date | date |
None. |
|
FileExt | string |
None. |
|
ShowSender | boolean |
None. |
|
ShowReceiver | boolean |
None. |
|
RefSenderCode | string |
None. |
|
RefDocumentTypeId | integer |
None. |
|
RefNumber | integer |
None. |
|
RefSeries | string |
None. |
|
RefDate | date |
None. |
|
StatusCode | string |
None. |
|
StatusDescription | string |
None. |
|
Document |
None. |
Response Formats
application/json, text/json
Sample:
[ { "AttachmentId": "cbfa0428-8e6d-48de-ba97-9cae489c9509", "DocumentId": "14b65039-ab9a-4bfb-abaa-623a04f75be6", "AttachmentTypeId": 3, "AttachmentTypeName": "sample string 4", "Name": "sample string 5", "Description": "sample string 6", "Date": "2024-11-15T03:13:16.9588619+00:00", "FileExt": "sample string 8", "ShowSender": true, "ShowReceiver": true, "RefSenderCode": "sample string 11", "RefDocumentTypeId": 12, "RefNumber": 13, "RefSeries": "sample string 14", "RefDate": "2024-11-15T03:13:16.9588619+00:00", "StatusCode": "sample string 16", "StatusDescription": "sample string 17", "Document": { "DocumentId": "0b58feac-2eca-4e08-bfe1-99946b3ec0c1", "SenderId": "0b6f40fe-3532-487e-80b8-898812d1f38e", "ReceiverId": "f076391b-bc83-4785-b2fa-4c3a47f7b503", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Country": "sample string 6", "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 7", "Number": 8, "Series": "sample string 9", "SenderCode": "sample string 10", "SenderName": "sample string 11", "ReceiverCode": "sample string 12", "ReceiverName": "sample string 13", "Date": "2024-11-15T03:13:16.9744786+00:00", "NetAmount": 15.0, "TaxAmount": 16.0, "FreeAmount": 17.0, "TotalAmount": 18.0, "DateNumber": 19, "Timestamp": "2024-11-15T03:13:16.9744786+00:00", "LastUpated": "2024-11-15T03:13:16.9744786+00:00", "SyncPointId": "1b41bdd6-1d10-49fe-a8cd-4b61f279cd65", "BatchId": "86b6762d-d619-455b-88bd-2ccdd9b72b5a", "CreationSource": "sample string 21", "CreatedBy": "sample string 22", "ExpirationDate": "2024-11-15T03:13:16.9744786+00:00", "ReceptionIRSDate": "2024-11-15T03:13:16.9744786+00:00", "CurrencyFactor": 23.0, "DocumentTag": { "Code": "sample string 1", "TimeStamp": "2024-11-15T03:13:16.9744786+00:00", "Value": "sample string 3", "Complement": "sample string 4" }, "DiscountAmount": 24.0, "PaymentMethod": "sample string 25", "TaxDetails": [ { "TaxCode": "sample string 1", "RateCode": "sample string 2", "Percent": 3.0, "TaxAmount": 4.0 }, { "TaxCode": "sample string 1", "RateCode": "sample string 2", "Percent": 3.0, "TaxAmount": 4.0 } ], "WayToPay": 1, "CountryDocumentId": "sample string 26", "SeriesNumber": "sample string 27" }, "CreatedById": "a3b29b66-0a84-44d6-a397-d79c81a62894", "CreationSource": "sample string 18", "CreatedBy": "sample string 19", "Timestamp": "2024-11-15T03:13:16.9744786+00:00", "LastUpated": "2024-11-15T03:13:16.9744786+00:00" }, { "AttachmentId": "cbfa0428-8e6d-48de-ba97-9cae489c9509", "DocumentId": "14b65039-ab9a-4bfb-abaa-623a04f75be6", "AttachmentTypeId": 3, "AttachmentTypeName": "sample string 4", "Name": "sample string 5", "Description": "sample string 6", "Date": "2024-11-15T03:13:16.9588619+00:00", "FileExt": "sample string 8", "ShowSender": true, "ShowReceiver": true, "RefSenderCode": "sample string 11", "RefDocumentTypeId": 12, "RefNumber": 13, "RefSeries": "sample string 14", "RefDate": "2024-11-15T03:13:16.9588619+00:00", "StatusCode": "sample string 16", "StatusDescription": "sample string 17", "Document": { "DocumentId": "0b58feac-2eca-4e08-bfe1-99946b3ec0c1", "SenderId": "0b6f40fe-3532-487e-80b8-898812d1f38e", "ReceiverId": "f076391b-bc83-4785-b2fa-4c3a47f7b503", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Country": "sample string 6", "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 7", "Number": 8, "Series": "sample string 9", "SenderCode": "sample string 10", "SenderName": "sample string 11", "ReceiverCode": "sample string 12", "ReceiverName": "sample string 13", "Date": "2024-11-15T03:13:16.9744786+00:00", "NetAmount": 15.0, "TaxAmount": 16.0, "FreeAmount": 17.0, "TotalAmount": 18.0, "DateNumber": 19, "Timestamp": "2024-11-15T03:13:16.9744786+00:00", "LastUpated": "2024-11-15T03:13:16.9744786+00:00", "SyncPointId": "1b41bdd6-1d10-49fe-a8cd-4b61f279cd65", "BatchId": "86b6762d-d619-455b-88bd-2ccdd9b72b5a", "CreationSource": "sample string 21", "CreatedBy": "sample string 22", "ExpirationDate": "2024-11-15T03:13:16.9744786+00:00", "ReceptionIRSDate": "2024-11-15T03:13:16.9744786+00:00", "CurrencyFactor": 23.0, "DocumentTag": { "Code": "sample string 1", "TimeStamp": "2024-11-15T03:13:16.9744786+00:00", "Value": "sample string 3", "Complement": "sample string 4" }, "DiscountAmount": 24.0, "PaymentMethod": "sample string 25", "TaxDetails": [ { "TaxCode": "sample string 1", "RateCode": "sample string 2", "Percent": 3.0, "TaxAmount": 4.0 }, { "TaxCode": "sample string 1", "RateCode": "sample string 2", "Percent": 3.0, "TaxAmount": 4.0 } ], "WayToPay": 1, "CountryDocumentId": "sample string 26", "SeriesNumber": "sample string 27" }, "CreatedById": "a3b29b66-0a84-44d6-a397-d79c81a62894", "CreationSource": "sample string 18", "CreatedBy": "sample string 19", "Timestamp": "2024-11-15T03:13:16.9744786+00:00", "LastUpated": "2024-11-15T03:13:16.9744786+00:00" } ]
application/xml, text/xml
Sample:
<ArrayOfAttachment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gosocket.Domain.Document"> <Attachment> <AttachmentId>cbfa0428-8e6d-48de-ba97-9cae489c9509</AttachmentId> <AttachmentTypeId>3</AttachmentTypeId> <AttachmentTypeName>sample string 4</AttachmentTypeName> <CreatedBy>sample string 19</CreatedBy> <CreatedById>a3b29b66-0a84-44d6-a397-d79c81a62894</CreatedById> <CreationSource>sample string 18</CreationSource> <Date>2024-11-15T03:13:16.9588619+00:00</Date> <Description>sample string 6</Description> <Document> <BatchId>86b6762d-d619-455b-88bd-2ccdd9b72b5a</BatchId> <Country>sample string 6</Country> <CountryDocumentId>sample string 26</CountryDocumentId> <CreatedBy>sample string 22</CreatedBy> <CreationSource>sample string 21</CreationSource> <CurrencyFactor>23</CurrencyFactor> <CurrencyTypeId>1</CurrencyTypeId> <CurrencyTypeName>sample string 7</CurrencyTypeName> <Date>2024-11-15T03:13:16.9744786+00:00</Date> <DateNumber>19</DateNumber> <DiscountAmount>24</DiscountAmount> <DocumentId>0b58feac-2eca-4e08-bfe1-99946b3ec0c1</DocumentId> <DocumentTag> <Code>sample string 1</Code> <Complement>sample string 4</Complement> <TimeStamp>2024-11-15T03:13:16.9744786+00:00</TimeStamp> <Value>sample string 3</Value> </DocumentTag> <DocumentTypeId>4</DocumentTypeId> <DocumentTypeName>sample string 5</DocumentTypeName> <ExpirationDate>2024-11-15T03:13:16.9744786+00:00</ExpirationDate> <FreeAmount>17</FreeAmount> <LastUpated>2024-11-15T03:13:16.9744786+00:00</LastUpated> <NetAmount>15</NetAmount> <Number>8</Number> <PaymentMethod>sample string 25</PaymentMethod> <ReceiverCode>sample string 12</ReceiverCode> <ReceiverId>f076391b-bc83-4785-b2fa-4c3a47f7b503</ReceiverId> <ReceiverName>sample string 13</ReceiverName> <ReceptionIRSDate>2024-11-15T03:13:16.9744786+00:00</ReceptionIRSDate> <SenderCode>sample string 10</SenderCode> <SenderId>0b6f40fe-3532-487e-80b8-898812d1f38e</SenderId> <SenderName>sample string 11</SenderName> <Series>sample string 9</Series> <SeriesNumber>sample string 27</SeriesNumber> <SyncPointId>1b41bdd6-1d10-49fe-a8cd-4b61f279cd65</SyncPointId> <TaxAmount>16</TaxAmount> <TaxDetails> <Tax> <Percent>3</Percent> <RateCode>sample string 2</RateCode> <TaxAmount>4</TaxAmount> <TaxCode>sample string 1</TaxCode> </Tax> <Tax> <Percent>3</Percent> <RateCode>sample string 2</RateCode> <TaxAmount>4</TaxAmount> <TaxCode>sample string 1</TaxCode> </Tax> </TaxDetails> <Timestamp>2024-11-15T03:13:16.9744786+00:00</Timestamp> <TotalAmount>18</TotalAmount> <WayToPay>1</WayToPay> </Document> <DocumentId>14b65039-ab9a-4bfb-abaa-623a04f75be6</DocumentId> <FileExt>sample string 8</FileExt> <LastUpated>2024-11-15T03:13:16.9744786+00:00</LastUpated> <Name>sample string 5</Name> <RefDate>2024-11-15T03:13:16.9588619+00:00</RefDate> <RefDocumentTypeId>12</RefDocumentTypeId> <RefNumber>13</RefNumber> <RefSenderCode>sample string 11</RefSenderCode> <RefSeries>sample string 14</RefSeries> <ShowReceiver>true</ShowReceiver> <ShowSender>true</ShowSender> <StatusCode>sample string 16</StatusCode> <StatusDescription>sample string 17</StatusDescription> <Timestamp>2024-11-15T03:13:16.9744786+00:00</Timestamp> </Attachment> <Attachment> <AttachmentId>cbfa0428-8e6d-48de-ba97-9cae489c9509</AttachmentId> <AttachmentTypeId>3</AttachmentTypeId> <AttachmentTypeName>sample string 4</AttachmentTypeName> <CreatedBy>sample string 19</CreatedBy> <CreatedById>a3b29b66-0a84-44d6-a397-d79c81a62894</CreatedById> <CreationSource>sample string 18</CreationSource> <Date>2024-11-15T03:13:16.9588619+00:00</Date> <Description>sample string 6</Description> <Document> <BatchId>86b6762d-d619-455b-88bd-2ccdd9b72b5a</BatchId> <Country>sample string 6</Country> <CountryDocumentId>sample string 26</CountryDocumentId> <CreatedBy>sample string 22</CreatedBy> <CreationSource>sample string 21</CreationSource> <CurrencyFactor>23</CurrencyFactor> <CurrencyTypeId>1</CurrencyTypeId> <CurrencyTypeName>sample string 7</CurrencyTypeName> <Date>2024-11-15T03:13:16.9744786+00:00</Date> <DateNumber>19</DateNumber> <DiscountAmount>24</DiscountAmount> <DocumentId>0b58feac-2eca-4e08-bfe1-99946b3ec0c1</DocumentId> <DocumentTag> <Code>sample string 1</Code> <Complement>sample string 4</Complement> <TimeStamp>2024-11-15T03:13:16.9744786+00:00</TimeStamp> <Value>sample string 3</Value> </DocumentTag> <DocumentTypeId>4</DocumentTypeId> <DocumentTypeName>sample string 5</DocumentTypeName> <ExpirationDate>2024-11-15T03:13:16.9744786+00:00</ExpirationDate> <FreeAmount>17</FreeAmount> <LastUpated>2024-11-15T03:13:16.9744786+00:00</LastUpated> <NetAmount>15</NetAmount> <Number>8</Number> <PaymentMethod>sample string 25</PaymentMethod> <ReceiverCode>sample string 12</ReceiverCode> <ReceiverId>f076391b-bc83-4785-b2fa-4c3a47f7b503</ReceiverId> <ReceiverName>sample string 13</ReceiverName> <ReceptionIRSDate>2024-11-15T03:13:16.9744786+00:00</ReceptionIRSDate> <SenderCode>sample string 10</SenderCode> <SenderId>0b6f40fe-3532-487e-80b8-898812d1f38e</SenderId> <SenderName>sample string 11</SenderName> <Series>sample string 9</Series> <SeriesNumber>sample string 27</SeriesNumber> <SyncPointId>1b41bdd6-1d10-49fe-a8cd-4b61f279cd65</SyncPointId> <TaxAmount>16</TaxAmount> <TaxDetails> <Tax> <Percent>3</Percent> <RateCode>sample string 2</RateCode> <TaxAmount>4</TaxAmount> <TaxCode>sample string 1</TaxCode> </Tax> <Tax> <Percent>3</Percent> <RateCode>sample string 2</RateCode> <TaxAmount>4</TaxAmount> <TaxCode>sample string 1</TaxCode> </Tax> </TaxDetails> <Timestamp>2024-11-15T03:13:16.9744786+00:00</Timestamp> <TotalAmount>18</TotalAmount> <WayToPay>1</WayToPay> </Document> <DocumentId>14b65039-ab9a-4bfb-abaa-623a04f75be6</DocumentId> <FileExt>sample string 8</FileExt> <LastUpated>2024-11-15T03:13:16.9744786+00:00</LastUpated> <Name>sample string 5</Name> <RefDate>2024-11-15T03:13:16.9588619+00:00</RefDate> <RefDocumentTypeId>12</RefDocumentTypeId> <RefNumber>13</RefNumber> <RefSenderCode>sample string 11</RefSenderCode> <RefSeries>sample string 14</RefSeries> <ShowReceiver>true</ShowReceiver> <ShowSender>true</ShowSender> <StatusCode>sample string 16</StatusCode> <StatusDescription>sample string 17</StatusDescription> <Timestamp>2024-11-15T03:13:16.9744786+00:00</Timestamp> </Attachment> </ArrayOfAttachment>