GET api/InvoiceSearchApi/ByNumber/{number}

Get invoice data by it's voucher number

Request Information

URI Parameters

Name	Description	Type	Additional information
number	Invoice number	string	Required

Body Parameters

None.

Response Information

Resource Description

Invoice data (address and voucher data)

DebtorVoucherContainer

Name	Description	Type	Additional information
Address		CustomAddress	None.
Voucher		CustomDebtorVoucher	None.

Response Formats

application/json, text/json

Sample:

{
  "Address": {
    "Birthday": "sample string 1",
    "CustomerIdShop": 2,
    "LanguageCode": "sample string 3",
    "CompanyName": "sample string 4",
    "AddressNumber": "sample string 5",
    "Title": "sample string 6",
    "LastName": "sample string 7",
    "FAO": "sample string 8",
    "Street": "sample string 9",
    "FirstName": "sample string 10",
    "Postcode": "sample string 11",
    "Place": "sample string 12",
    "Country": "sample string 13",
    "PhoneBusiness": "sample string 14",
    "PhoneHome": "sample string 15",
    "FaxNumber": "sample string 16",
    "Salutation": "sample string 17",
    "PhoneMobile": "sample string 18",
    "Notes": "sample string 19",
    "PostOfficeBox": "sample string 20",
    "Email": "sample string 21",
    "Homepage": "sample string 22",
    "DateModified": "2024-05-07T17:59:39.1216252+02:00",
    "Id": 23
  },
  "Voucher": {
    "OrderBalance": 1.0,
    "PaymentTotal": 2.0,
    "RateBalance": 3.0,
    "RateCount": 4,
    "RateInterval": 5,
    "DueDate": "2024-05-07T17:59:39.1216252+02:00",
    "IsNetVoucher": true,
    "StatusBackup": "sample string 8",
    "AssignedClient": "sample string 9",
    "OrderNumber": "sample string 10",
    "ExternalNumber": "sample string 11",
    "ReversalState": "sample string 12",
    "PrePaymentFlag": "sample string 13",
    "AddressNumber": "sample string 14",
    "VoucherNumber": "sample string 15",
    "DateVoucher": "2024-05-07T17:59:39.1216252+02:00",
    "Status": 0,
    "DatePayment": "2024-05-07T17:59:39.1216252+02:00",
    "DatePaymentReminder": "2024-05-07T17:59:39.1216252+02:00",
    "Balance": 1.0,
    "DateModified": "2024-05-07T17:59:39.1216252+02:00",
    "SplitRows": [
      {
        "AccountNumber": "sample string 1",
        "Text": "sample string 2",
        "RateVat": 3.0,
        "RateTax": 4.0,
        "Amount": 5.0,
        "AmountTax": 6.0,
        "AmountVat": 7.0,
        "AdditionalFields": [
          {
            "Field": 1,
            "Value": "sample string 2"
          },
          {
            "Field": 1,
            "Value": "sample string 2"
          }
        ]
      },
      {
        "AccountNumber": "sample string 1",
        "Text": "sample string 2",
        "RateVat": 3.0,
        "RateTax": 4.0,
        "Amount": 5.0,
        "AmountTax": 6.0,
        "AmountVat": 7.0,
        "AdditionalFields": [
          {
            "Field": 1,
            "Value": "sample string 2"
          },
          {
            "Field": 1,
            "Value": "sample string 2"
          }
        ]
      }
    ],
    "AdditionalFields": [
      {
        "Field": 1,
        "Value": "sample string 2"
      },
      {
        "Field": 1,
        "Value": "sample string 2"
      }
    ],
    "CreationType": 1,
    "Id": 16
  }
}

application/xml, text/xml

Sample:

<DebtorVoucherContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models.Api">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models">
    <AddressNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 5</AddressNumber>
    <Country xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 13</Country>
    <DateModified xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">2024-05-07T17:59:39.1216252+02:00</DateModified>
    <Email xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 21</Email>
    <FAO xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 8</FAO>
    <FaxNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 16</FaxNumber>
    <FirstName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 10</FirstName>
    <Homepage xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 22</Homepage>
    <Id xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">23</Id>
    <LastName xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 7</LastName>
    <Notes xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 19</Notes>
    <PhoneBusiness xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 14</PhoneBusiness>
    <PhoneHome xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 15</PhoneHome>
    <PhoneMobile xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 18</PhoneMobile>
    <Place xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 12</Place>
    <PostOfficeBox xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 20</PostOfficeBox>
    <Postcode xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 11</Postcode>
    <Salutation xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 17</Salutation>
    <Street xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 9</Street>
    <Title xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Basic">sample string 6</Title>
    <d2p1:Birthday>sample string 1</d2p1:Birthday>
    <d2p1:CompanyName>sample string 4</d2p1:CompanyName>
    <d2p1:CustomerIdShop>2</d2p1:CustomerIdShop>
    <d2p1:LanguageCode>sample string 3</d2p1:LanguageCode>
  </Address>
  <Voucher xmlns:d2p1="http://schemas.datacontract.org/2004/07/E3k.Web.CustomerPortal.Models">
    <AdditionalFields xmlns:d3p1="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Extended" xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">
      <d3p1:AdditionalField>
        <d3p1:Field>1</d3p1:Field>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:AdditionalField>
      <d3p1:AdditionalField>
        <d3p1:Field>1</d3p1:Field>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:AdditionalField>
    </AdditionalFields>
    <AddressNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">sample string 14</AddressNumber>
    <Balance xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">1</Balance>
    <CreationType xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">Invoice</CreationType>
    <DateModified xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">2024-05-07T17:59:39.1216252+02:00</DateModified>
    <DatePayment xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">2024-05-07T17:59:39.1216252+02:00</DatePayment>
    <DatePaymentReminder xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">2024-05-07T17:59:39.1216252+02:00</DatePaymentReminder>
    <DateVoucher xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">2024-05-07T17:59:39.1216252+02:00</DateVoucher>
    <Id xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">16</Id>
    <SplitRows xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">
      <SplitRow>
        <AccountNumber>sample string 1</AccountNumber>
        <AdditionalFields xmlns:d5p1="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Extended">
          <d5p1:AdditionalField>
            <d5p1:Field>1</d5p1:Field>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:AdditionalField>
          <d5p1:AdditionalField>
            <d5p1:Field>1</d5p1:Field>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:AdditionalField>
        </AdditionalFields>
        <Amount>5</Amount>
        <AmountTax>6</AmountTax>
        <AmountVat>7</AmountVat>
        <RateTax>4</RateTax>
        <RateVat>3</RateVat>
        <Text>sample string 2</Text>
      </SplitRow>
      <SplitRow>
        <AccountNumber>sample string 1</AccountNumber>
        <AdditionalFields xmlns:d5p1="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Extended">
          <d5p1:AdditionalField>
            <d5p1:Field>1</d5p1:Field>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:AdditionalField>
          <d5p1:AdditionalField>
            <d5p1:Field>1</d5p1:Field>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:AdditionalField>
        </AdditionalFields>
        <Amount>5</Amount>
        <AmountTax>6</AmountTax>
        <AmountVat>7</AmountVat>
        <RateTax>4</RateTax>
        <RateVat>3</RateVat>
        <Text>sample string 2</Text>
      </SplitRow>
    </SplitRows>
    <Status xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">OpenInvoice</Status>
    <VoucherNumber xmlns="http://schemas.datacontract.org/2004/07/E3k.Web.Objects.DataTransfer.Finance">sample string 15</VoucherNumber>
    <d2p1:AssignedClient>sample string 9</d2p1:AssignedClient>
    <d2p1:DueDate>2024-05-07T17:59:39.1216252+02:00</d2p1:DueDate>
    <d2p1:ExternalNumber>sample string 11</d2p1:ExternalNumber>
    <d2p1:IsNetVoucher>true</d2p1:IsNetVoucher>
    <d2p1:OrderBalance>1</d2p1:OrderBalance>
    <d2p1:OrderNumber>sample string 10</d2p1:OrderNumber>
    <d2p1:PaymentTotal>2</d2p1:PaymentTotal>
    <d2p1:PrePaymentFlag>sample string 13</d2p1:PrePaymentFlag>
    <d2p1:RateBalance>3</d2p1:RateBalance>
    <d2p1:RateCount>4</d2p1:RateCount>
    <d2p1:RateInterval>5</d2p1:RateInterval>
    <d2p1:ReversalState>sample string 12</d2p1:ReversalState>
    <d2p1:StatusBackup>sample string 8</d2p1:StatusBackup>
  </Voucher>
</DebtorVoucherContainer>