POST api/Sync/GetSendDocuments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
From	date	None.
To	date	None.
SenderCodes	Collection of string	None.
Serie	string	None.
Number	integer	None.
ReceiverCode	string	None.
CountryId	string	None.
CustomValues	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "From": "2025-04-04T06:39:50.2958766+00:00",
  "To": "2025-04-04T06:39:50.2958766+00:00",
  "SenderCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "Serie": "sample string 3",
  "Number": 4,
  "ReceiverCode": "sample string 5",
  "CountryId": "sample string 6",
  "CustomValues": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<GetSentDocumentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gosocket.Web.Api.Models">
  <CountryId>sample string 6</CountryId>
  <CustomValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CustomValues>
  <From>2025-04-04T06:39:50.2958766+00:00</From>
  <Number>4</Number>
  <ReceiverCode>sample string 5</ReceiverCode>
  <SenderCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SenderCodes>
  <Serie>sample string 3</Serie>
  <To>2025-04-04T06:39:50.2958766+00:00</To>
</GetSentDocumentsModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetSentDocumentsModel'.

Response Information

Resource Description

Collection of Document

Name	Type	Additional information
DocumentTypeId	integer	None.
DocumentTypeName	string	None.
Country	string	None.
CurrencyTypeName	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.
LastUpated	date	None.
SyncPointId	globally unique identifier	None.
BatchId	globally unique identifier	None.
CreationSource	string	None.
CreatedBy	string	None.
ExpirationDate	date	None.
ReceptionIRSDate	date	None.
CurrencyFactor	decimal number	None.
DocumentTag	DocumentTag	None.
DiscountAmount	decimal number	None.
PaymentMethod	string	None.
TaxDetails	Collection of Tax	None.
WayToPay	integer	None.
CountryDocumentId	string	None.
SeriesNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentId": "f5055db5-25ff-4320-b374-42ffb8c45d5c",
    "SenderId": "2df87cbb-79d3-4323-a044-c97a2ad1babd",
    "ReceiverId": "d4d42ee1-88ec-4f6a-8bc8-1bb4acec6df6",
    "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": "2025-04-04T06:39:50.3583821+00:00",
    "NetAmount": 15.0,
    "TaxAmount": 16.0,
    "FreeAmount": 17.0,
    "TotalAmount": 18.0,
    "DateNumber": 19,
    "Timestamp": "2025-04-04T06:39:50.3583821+00:00",
    "LastUpated": "2025-04-04T06:39:50.3583821+00:00",
    "SyncPointId": "8e172172-d32c-4124-b84d-be9862f55615",
    "BatchId": "6c794785-d0f8-4a39-bca0-27cc6ea90256",
    "CreationSource": "sample string 21",
    "CreatedBy": "sample string 22",
    "ExpirationDate": "2025-04-04T06:39:50.3583821+00:00",
    "ReceptionIRSDate": "2025-04-04T06:39:50.3583821+00:00",
    "CurrencyFactor": 23.0,
    "DocumentTag": {
      "Code": "sample string 1",
      "TimeStamp": "2025-04-04T06:39:50.3583821+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"
  },
  {
    "DocumentId": "f5055db5-25ff-4320-b374-42ffb8c45d5c",
    "SenderId": "2df87cbb-79d3-4323-a044-c97a2ad1babd",
    "ReceiverId": "d4d42ee1-88ec-4f6a-8bc8-1bb4acec6df6",
    "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": "2025-04-04T06:39:50.3583821+00:00",
    "NetAmount": 15.0,
    "TaxAmount": 16.0,
    "FreeAmount": 17.0,
    "TotalAmount": 18.0,
    "DateNumber": 19,
    "Timestamp": "2025-04-04T06:39:50.3583821+00:00",
    "LastUpated": "2025-04-04T06:39:50.3583821+00:00",
    "SyncPointId": "8e172172-d32c-4124-b84d-be9862f55615",
    "BatchId": "6c794785-d0f8-4a39-bca0-27cc6ea90256",
    "CreationSource": "sample string 21",
    "CreatedBy": "sample string 22",
    "ExpirationDate": "2025-04-04T06:39:50.3583821+00:00",
    "ReceptionIRSDate": "2025-04-04T06:39:50.3583821+00:00",
    "CurrencyFactor": 23.0,
    "DocumentTag": {
      "Code": "sample string 1",
      "TimeStamp": "2025-04-04T06:39:50.3583821+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"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gosocket.Domain.Document">
  <Document>
    <BatchId>6c794785-d0f8-4a39-bca0-27cc6ea90256</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>2025-04-04T06:39:50.3583821+00:00</Date>
    <DateNumber>19</DateNumber>
    <DiscountAmount>24</DiscountAmount>
    <DocumentId>f5055db5-25ff-4320-b374-42ffb8c45d5c</DocumentId>
    <DocumentTag>
      <Code>sample string 1</Code>
      <Complement>sample string 4</Complement>
      <TimeStamp>2025-04-04T06:39:50.3583821+00:00</TimeStamp>
      <Value>sample string 3</Value>
    </DocumentTag>
    <DocumentTypeId>4</DocumentTypeId>
    <DocumentTypeName>sample string 5</DocumentTypeName>
    <ExpirationDate>2025-04-04T06:39:50.3583821+00:00</ExpirationDate>
    <FreeAmount>17</FreeAmount>
    <LastUpated>2025-04-04T06:39:50.3583821+00:00</LastUpated>
    <NetAmount>15</NetAmount>
    <Number>8</Number>
    <PaymentMethod>sample string 25</PaymentMethod>
    <ReceiverCode>sample string 12</ReceiverCode>
    <ReceiverId>d4d42ee1-88ec-4f6a-8bc8-1bb4acec6df6</ReceiverId>
    <ReceiverName>sample string 13</ReceiverName>
    <ReceptionIRSDate>2025-04-04T06:39:50.3583821+00:00</ReceptionIRSDate>
    <SenderCode>sample string 10</SenderCode>
    <SenderId>2df87cbb-79d3-4323-a044-c97a2ad1babd</SenderId>
    <SenderName>sample string 11</SenderName>
    <Series>sample string 9</Series>
    <SeriesNumber>sample string 27</SeriesNumber>
    <SyncPointId>8e172172-d32c-4124-b84d-be9862f55615</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>2025-04-04T06:39:50.3583821+00:00</Timestamp>
    <TotalAmount>18</TotalAmount>
    <WayToPay>1</WayToPay>
  </Document>
  <Document>
    <BatchId>6c794785-d0f8-4a39-bca0-27cc6ea90256</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>2025-04-04T06:39:50.3583821+00:00</Date>
    <DateNumber>19</DateNumber>
    <DiscountAmount>24</DiscountAmount>
    <DocumentId>f5055db5-25ff-4320-b374-42ffb8c45d5c</DocumentId>
    <DocumentTag>
      <Code>sample string 1</Code>
      <Complement>sample string 4</Complement>
      <TimeStamp>2025-04-04T06:39:50.3583821+00:00</TimeStamp>
      <Value>sample string 3</Value>
    </DocumentTag>
    <DocumentTypeId>4</DocumentTypeId>
    <DocumentTypeName>sample string 5</DocumentTypeName>
    <ExpirationDate>2025-04-04T06:39:50.3583821+00:00</ExpirationDate>
    <FreeAmount>17</FreeAmount>
    <LastUpated>2025-04-04T06:39:50.3583821+00:00</LastUpated>
    <NetAmount>15</NetAmount>
    <Number>8</Number>
    <PaymentMethod>sample string 25</PaymentMethod>
    <ReceiverCode>sample string 12</ReceiverCode>
    <ReceiverId>d4d42ee1-88ec-4f6a-8bc8-1bb4acec6df6</ReceiverId>
    <ReceiverName>sample string 13</ReceiverName>
    <ReceptionIRSDate>2025-04-04T06:39:50.3583821+00:00</ReceptionIRSDate>
    <SenderCode>sample string 10</SenderCode>
    <SenderId>2df87cbb-79d3-4323-a044-c97a2ad1babd</SenderId>
    <SenderName>sample string 11</SenderName>
    <Series>sample string 9</Series>
    <SeriesNumber>sample string 27</SeriesNumber>
    <SyncPointId>8e172172-d32c-4124-b84d-be9862f55615</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>2025-04-04T06:39:50.3583821+00:00</Timestamp>
    <TotalAmount>18</TotalAmount>
    <WayToPay>1</WayToPay>
  </Document>
</ArrayOfDocument>