POST api/Invoice/GetInboxInvoice

Request Information

URI Parameters

None.

Body Parameters

SearchInboxInvoiceRequest
NameDescriptionTypeAdditional information
IntegratorProfileId

string

None.

InvoiceId

string

None.

Uuid

string

None.

StartDate

date

None.

EndDate

date

None.

PageIndex

integer

None.

PageSize

integer

None.

Token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "IntegratorProfileId": "sample string 1",
  "InvoiceId": "sample string 2",
  "Uuid": "sample string 3",
  "StartDate": "2024-02-29T14:02:43.384412+03:00",
  "EndDate": "2024-02-29T14:02:43.384412+03:00",
  "PageIndex": 6,
  "PageSize": 7,
  "Token": "sample string 8"
}

application/xml, text/xml

Sample:
<SearchInboxInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Invoice">
  <Token xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 8</Token>
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">6</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">7</PageSize>
  <EndDate>2024-02-29T14:02:43.384412+03:00</EndDate>
  <IntegratorProfileId>sample string 1</IntegratorProfileId>
  <InvoiceId>sample string 2</InvoiceId>
  <StartDate>2024-02-29T14:02:43.384412+03:00</StartDate>
  <Uuid>sample string 3</Uuid>
</SearchInboxInvoiceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchInvoiceInboxResponse
NameDescriptionTypeAdditional information
Invoices

Collection of InboxInvoice

None.

TotalCount

integer

None.

ErrorCode

string

None.

ErrorMessage

string

None.

ErrorCategory

string

None.

Result

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Invoices": [
    {
      "IntegratorUserInvoiceId": 1,
      "IntegratorProfileId": "sample string 2",
      "IntegratorCompanyId": 3,
      "UUid": "sample string 4",
      "InvoiceId": "sample string 5",
      "SupplierIdentification": "sample string 6",
      "SupplierName": "sample string 7",
      "CustomerIdentification": "sample string 8",
      "CustomerName": "sample string 9",
      "InvoiceScenario": "sample string 10",
      "InvoiceProfile": "sample string 11",
      "InvoiceType": "sample string 12",
      "EArchiveSendingType": "sample string 13",
      "EArchiveType": "sample string 14",
      "StatusCode": "sample string 15",
      "Status": "sample string 16",
      "IssueDate": "2024-02-29T14:02:43.384412+03:00",
      "NetAmount": 18.0,
      "TaxAmount": 19.0,
      "DiscountAmount": 20.0,
      "TotalAmount": 21.0,
      "CurrencyCode": "sample string 22",
      "InvoiceDirection": "sample string 23",
      "GibStatusCode": "sample string 24",
      "GibStatus": "sample string 25",
      "InvoiceStatus": 64,
      "From": "sample string 27",
      "To": "sample string 28",
      "InvoiceCreationTime": "2024-02-29T14:02:43.384412+03:00",
      "EnvelopeId": "sample string 30"
    },
    {
      "IntegratorUserInvoiceId": 1,
      "IntegratorProfileId": "sample string 2",
      "IntegratorCompanyId": 3,
      "UUid": "sample string 4",
      "InvoiceId": "sample string 5",
      "SupplierIdentification": "sample string 6",
      "SupplierName": "sample string 7",
      "CustomerIdentification": "sample string 8",
      "CustomerName": "sample string 9",
      "InvoiceScenario": "sample string 10",
      "InvoiceProfile": "sample string 11",
      "InvoiceType": "sample string 12",
      "EArchiveSendingType": "sample string 13",
      "EArchiveType": "sample string 14",
      "StatusCode": "sample string 15",
      "Status": "sample string 16",
      "IssueDate": "2024-02-29T14:02:43.384412+03:00",
      "NetAmount": 18.0,
      "TaxAmount": 19.0,
      "DiscountAmount": 20.0,
      "TotalAmount": 21.0,
      "CurrencyCode": "sample string 22",
      "InvoiceDirection": "sample string 23",
      "GibStatusCode": "sample string 24",
      "GibStatus": "sample string 25",
      "InvoiceStatus": 64,
      "From": "sample string 27",
      "To": "sample string 28",
      "InvoiceCreationTime": "2024-02-29T14:02:43.384412+03:00",
      "EnvelopeId": "sample string 30"
    }
  ],
  "TotalCount": 1,
  "ErrorCode": "sample string 2",
  "ErrorMessage": "sample string 3",
  "ErrorCategory": "sample string 4",
  "Result": true
}

application/xml, text/xml

Sample:
<SearchInvoiceInboxResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Invoice">
  <ErrorCategory xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 4</ErrorCategory>
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 2</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 3</ErrorMessage>
  <Result xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">true</Result>
  <TotalCount xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">1</TotalCount>
  <Invoices>
    <InboxInvoice>
      <CurrencyCode>sample string 22</CurrencyCode>
      <CustomerIdentification>sample string 8</CustomerIdentification>
      <CustomerName>sample string 9</CustomerName>
      <DiscountAmount>20</DiscountAmount>
      <EArchiveSendingType>sample string 13</EArchiveSendingType>
      <EArchiveType>sample string 14</EArchiveType>
      <EnvelopeId>sample string 30</EnvelopeId>
      <From>sample string 27</From>
      <GibStatus>sample string 25</GibStatus>
      <GibStatusCode>sample string 24</GibStatusCode>
      <IntegratorCompanyId>3</IntegratorCompanyId>
      <IntegratorProfileId>sample string 2</IntegratorProfileId>
      <IntegratorUserInvoiceId>1</IntegratorUserInvoiceId>
      <InvoiceCreationTime>2024-02-29T14:02:43.384412+03:00</InvoiceCreationTime>
      <InvoiceDirection>sample string 23</InvoiceDirection>
      <InvoiceId>sample string 5</InvoiceId>
      <InvoiceProfile>sample string 11</InvoiceProfile>
      <InvoiceScenario>sample string 10</InvoiceScenario>
      <InvoiceStatus>64</InvoiceStatus>
      <InvoiceType>sample string 12</InvoiceType>
      <IssueDate>2024-02-29T14:02:43.384412+03:00</IssueDate>
      <NetAmount>18</NetAmount>
      <Status>sample string 16</Status>
      <StatusCode>sample string 15</StatusCode>
      <SupplierIdentification>sample string 6</SupplierIdentification>
      <SupplierName>sample string 7</SupplierName>
      <TaxAmount>19</TaxAmount>
      <To>sample string 28</To>
      <TotalAmount>21</TotalAmount>
      <UUid>sample string 4</UUid>
    </InboxInvoice>
    <InboxInvoice>
      <CurrencyCode>sample string 22</CurrencyCode>
      <CustomerIdentification>sample string 8</CustomerIdentification>
      <CustomerName>sample string 9</CustomerName>
      <DiscountAmount>20</DiscountAmount>
      <EArchiveSendingType>sample string 13</EArchiveSendingType>
      <EArchiveType>sample string 14</EArchiveType>
      <EnvelopeId>sample string 30</EnvelopeId>
      <From>sample string 27</From>
      <GibStatus>sample string 25</GibStatus>
      <GibStatusCode>sample string 24</GibStatusCode>
      <IntegratorCompanyId>3</IntegratorCompanyId>
      <IntegratorProfileId>sample string 2</IntegratorProfileId>
      <IntegratorUserInvoiceId>1</IntegratorUserInvoiceId>
      <InvoiceCreationTime>2024-02-29T14:02:43.384412+03:00</InvoiceCreationTime>
      <InvoiceDirection>sample string 23</InvoiceDirection>
      <InvoiceId>sample string 5</InvoiceId>
      <InvoiceProfile>sample string 11</InvoiceProfile>
      <InvoiceScenario>sample string 10</InvoiceScenario>
      <InvoiceStatus>64</InvoiceStatus>
      <InvoiceType>sample string 12</InvoiceType>
      <IssueDate>2024-02-29T14:02:43.384412+03:00</IssueDate>
      <NetAmount>18</NetAmount>
      <Status>sample string 16</Status>
      <StatusCode>sample string 15</StatusCode>
      <SupplierIdentification>sample string 6</SupplierIdentification>
      <SupplierName>sample string 7</SupplierName>
      <TaxAmount>19</TaxAmount>
      <To>sample string 28</To>
      <TotalAmount>21</TotalAmount>
      <UUid>sample string 4</UUid>
    </InboxInvoice>
  </Invoices>
</SearchInvoiceInboxResponse>