SearchEbizWebForm
Description
The SearchEbizWebForm method retrieves EbizWebForm objects.
Syntax
EbizWebForm[] (SecurityToken securityToken, SearchFilter[] filters, int start, int limit, string sort)
Arguments
Type | Name | Description | |
|---|---|---|---|
securityToken | R | A unique token that is used to identify a merchant and authenticate the API request. | |
filters | O | Filter webforms by one or more field names, comparison operators, and field values. See supported search parameters below. | |
int | start | R | Index of the first object to return in the array. Note: Must be ≥ 0. |
int | limit | R | Maximum number of objects to return. Note: Must be > 0. |
string | sort | O | Sorts by field name. Supported Sort Field Names
|
Supported Search Parameters
| Parameter | Description | Example Use |
|---|---|---|
| PaymentInternalId | Filters by the internal payment ID. | |
| FormType | Filters by form type. | |
| CustomerId | Filters by the customer ID. | |
| InvoiceNumber | Filters by the invoice number. | |
| AmountDue | Filters by the amount due. | |
| SoNum | Filters by the sales order number. | |
| OrderId | Filters by the order ID. | |
| TotalAmount | Filters by the total amount. | |
| AmountDue | Filters by the amount due. | |
| SoftwareId | Filters by the software ID. | |
| TransactionLookupKey | Filters by the transaction lookup key. | |
| DocumentTypeId | Filters by the document type ID. | |
| IsPaid | Filters by whether the webform has been paid. | |
| IsApplied | Filters by whether the webform has been sent to be processed. | |
| IsDeleted | Filters by whether the webform has been deleted. | |
| IsUpdated | Filters by whether the webform has been updated. | |
| DateCreated | Filters by the date the webform was created. | |
| DatePaid | Filters by the date the webform was paid. | |
| DateApplied | Filters by the date the webform was sent to be processed. | |
| DateDeleted | Filters by the date the webform was deleted. | |
Return Value
| Type | Description |
|---|---|
| EbizWebForm[] | On success, returns a list of EbizWebform objects. Otherwise, returns an error. |
Example Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
<soapenv:Header/>
<soapenv:Body>
<ebiz:SearchEbizWebForm>
<ebiz:securityToken>
<ebiz:SecurityId>**************4bf0-91cd**************</ebiz:SecurityId>
<ebiz:UserId/>
<ebiz:Password/>
</ebiz:securityToken>
<ebiz:filters>
<ebiz:SearchFilter>
<ebiz:FieldName>PaymentInternalId</ebiz:FieldName>
<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>
<ebiz:FieldValue>********-79db-4443-b238-************</ebiz:FieldValue>
</ebiz:SearchFilter>
</ebiz:filters>
<ebiz:start>0</ebiz:start>
<ebiz:limit>3</ebiz:limit>
<ebiz:sort/>
</ebiz:SearchEbizWebForm>
</soapenv:Body>
</soapenv:Envelope>public static void SearchEbizWebForm()
{
IeBizService apiClient = new IeBizServiceClient();
SecurityToken securityToken = new SecurityToken
{
SecurityId = TestSecurityId,
UserId = "",
Password = ""
};
SearchFilter[] filters =
{
new SearchFilter
{
FieldName = "PaymentInternalId",
ComparisonOperator = "eq",
FieldValue = "********-79db-4443-b238-************"
}
};
EbizWebFormSearchResult result = apiClient.SearchEbizWebForm(
securityToken,
filters,
0,
100,
null
);
if (result == null || result.Results == null || result.Results.Length == 0)
{
Console.WriteLine("No EbizWebForms found.");
return;
}
Console.WriteLine($"Total Count: {result.TotalCount}");
Console.WriteLine($"Status: {result.Status}");
Console.WriteLine($"Status Code: {result.StatusCode}");
Console.WriteLine(new string('-', 50));
foreach (EbizWebFormResult wf in result.Results)
{
Console.WriteLine($"Payment Internal ID: {wf.PaymentInternalId}");
Console.WriteLine($"Invoice Number: {wf.EbizWebForm?.InvoiceNumber}");
Console.WriteLine($"PO Number: {wf.EbizWebForm?.PoNum}");
Console.WriteLine($"SO Number: {wf.EbizWebForm?.SoNum}");
Console.WriteLine($"Order ID: {wf.EbizWebForm?.OrderId}");
Console.WriteLine($"Description: {wf.EbizWebForm?.Description}");
Console.WriteLine($"Amount Due: {wf.EbizWebForm?.AmountDue}");
Console.WriteLine($"Total Amount: {wf.EbizWebForm?.TotalAmount}");
Console.WriteLine($"Tax Amount: {wf.EbizWebForm?.TaxAmount}");
Console.WriteLine($"Shipping Amount: {wf.EbizWebForm?.ShippingAmount}");
Console.WriteLine($"Customer ID: {wf.EbizWebForm?.CustomerId}");
Console.WriteLine($"Customer Name: {wf.EbizWebForm?.CustFullName}");
Console.WriteLine(new string('-', 50));
}
}function searchEbizWebForm($client, $securityToken): void
{
$client = new SoapClient('End Point URL');
$securityToken = array(
'SecurityId' => '********-1b21-421b-86ce-************',
'UserId' => 'merchant1',
'Password' => 'merchant1'
);
$filters = [
[
'FieldName' => 'PaymentInternalId',
'ComparisonOperator' => 'eq',
'FieldValue' => '********-79db-4443-b238-************',
],
];
$response = $client->SearchEbizWebForm([
'securityToken' => $securityToken,
'filters' => $filters,
'start' => 0,
'limit' => 100,
'sort' => null,
]);
$result = $response->SearchEbizWebFormResult ?? null;
if (empty($result) || empty($result->Results)) {
echo "No EbizWebForms found." . PHP_EOL;
return;
}
echo "Total Count: " . ($result->TotalCount ?? '') . PHP_EOL;
echo "Status: " . ($result->Status ?? '') . PHP_EOL;
echo "Status Code: " . ($result->StatusCode ?? '') . PHP_EOL;
echo str_repeat('-', 50) . PHP_EOL;
// Normalize to array regardless of single or multiple results
$webForms = $result->Results->EbizWebFormResult ?? [];
if (!is_array($webForms)) {
$webForms = [$webForms];
}
foreach ($webForms as $wf) {
$form = $wf->EbizWebForm ?? null;
echo "Payment Internal ID: " . ($wf->PaymentInternalId ?? '') . PHP_EOL;
echo "Invoice Number: " . ($form->InvoiceNumber ?? '') . PHP_EOL;
echo "PO Number: " . ($form->PoNum ?? '') . PHP_EOL;
echo "SO Number: " . ($form->SoNum ?? '') . PHP_EOL;
echo "Order ID: " . ($form->OrderId ?? '') . PHP_EOL;
echo "Description: " . ($form->Description ?? '') . PHP_EOL;
echo "Amount Due: " . ($form->AmountDue ?? '') . PHP_EOL;
echo "Total Amount: " . ($form->TotalAmount ?? '') . PHP_EOL;
echo "Tax Amount: " . ($form->TaxAmount ?? '') . PHP_EOL;
echo "Shipping Amount: " . ($form->ShippingAmount ?? '') . PHP_EOL;
echo "Customer ID: " . ($form->CustomerId ?? '') . PHP_EOL;
echo "Customer Name: " . ($form->CustFullName ?? '') . PHP_EOL;
echo str_repeat('-', 50) . PHP_EOL;
}
}Example Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SearchEbizWebFormResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
<SearchEbizWebFormResult>
<Results>
<EbizWebFormResult>
<EbizWebForm>
<EmailAddress>[email protected]</EmailAddress>
<EmailTemplateID>**************4bf0-91cd**************</EmailTemplateID>
<SendEmailToCustomer>true</SendEmailToCustomer>
<CustomerId>m0901-1</CustomerId>
<CustFullName>John22 Doe23</CustFullName>
<InvoiceNumber>Inv1-012</InvoiceNumber>
<Date xsi:nil="true"/>
<DueDate>2024-10-21T00:00:00</DueDate>
<TotalAmount>5.32</TotalAmount>
<AmountDue>5.01</AmountDue>
<TipAmount xsi:nil="true"/>
<ShippingAmount xsi:nil="true"/>
<DutyAmount xsi:nil="true"/>
<TaxAmount xsi:nil="true"/>
<DisplayDefaultResultPage xsi:nil="true"/>
<SavePaymentMethod xsi:nil="true"/>
<ShowSavedPaymentMethods xsi:nil="true"/>
<LineItems/>
<ShowViewInvoiceLink>true</ShowViewInvoiceLink>
<ShowViewSalesOrderLink xsi:nil="true"/>
</EbizWebForm>
<PaymentInternalId>**************4bf0-91cd**************</PaymentInternalId>
<IsPaid>false</IsPaid>
<IsApplied>false</IsApplied>
<IsDeleted>false</IsDeleted>
<IsUpdated>false</IsUpdated>
<DateCreated>2026-05-06T21:11:26</DateCreated>
<DateLastUpdated/>
<DatePaid/>
<DateApplied/>
<DateDeleted/>
</EbizWebFormResult>
<EbizWebFormResult>
<EbizWebForm>
<EmailAddress>[email protected]</EmailAddress>
<EmailTemplateID>**************4bf0-91cd**************</EmailTemplateID>
<SendEmailToCustomer>true</SendEmailToCustomer>
<CustomerId>m0901-1</CustomerId>
<CustFullName>John22 Doe23</CustFullName>
<InvoiceNumber>Inv1-012</InvoiceNumber>
<Date xsi:nil="true"/>
<DueDate>2024-10-21T00:00:00</DueDate>
<TotalAmount>5.32</TotalAmount>
<AmountDue>5.01</AmountDue>
<TipAmount xsi:nil="true"/>
<ShippingAmount xsi:nil="true"/>
<DutyAmount xsi:nil="true"/>
<TaxAmount xsi:nil="true"/>
<DisplayDefaultResultPage xsi:nil="true"/>
<SavePaymentMethod xsi:nil="true"/>
<ShowSavedPaymentMethods xsi:nil="true"/>
<LineItems/>
<ShowViewInvoiceLink>true</ShowViewInvoiceLink>
<ShowViewSalesOrderLink xsi:nil="true"/>
</EbizWebForm>
<PaymentInternalId>**************4bf0-91cd**************</PaymentInternalId>
<IsPaid>false</IsPaid>
<IsApplied>false</IsApplied>
<IsDeleted>false</IsDeleted>
<IsUpdated>false</IsUpdated>
<DateCreated>2026-04-20T23:15:23</DateCreated>
<DateLastUpdated/>
<DatePaid/>
<DateApplied/>
<DateDeleted/>
</EbizWebFormResult>
<EbizWebFormResult>
<EbizWebForm>
<FormType>Webform</FormType>
<FromEmail>[email protected]</FromEmail>
<FromName>CBS</FromName>
<EmailAddress>[email protected]</EmailAddress>
<CcEmailAddress>[email protected]</CcEmailAddress>
<BccEmailAddress>[email protected]</BccEmailAddress>
<ReplyToEmailAddress>**************4bf0-91cd**************</ReplyToEmailAddress>
<ReplyToDisplayName>CBS</ReplyToDisplayName>
<EmailNotes/>
<EmailNotesHTML/>
<EmailSubject/>
<EmailTemplateID>WebFormEmail</EmailTemplateID>
<EmailTemplateName/>
<SendEmailToCustomer>true</SendEmailToCustomer>
<CustomerId>8</CustomerId>
<CustFullName>Sample</CustFullName>
<TransId/>
<TransDetail/>
<InvoiceNumber>INV852555</InvoiceNumber>
<PoNum>PO9909</PoNum>
<SoNum>SO9867</SoNum>
<OrderId>88585</OrderId>
<Date xsi:nil="true"/>
<DueDate xsi:nil="true"/>
<TotalAmount>1.0</TotalAmount>
<AmountDue>1.0</AmountDue>
<TipAmount>1.0</TipAmount>
<ShippingAmount>1.0</ShippingAmount>
<DutyAmount>1.0</DutyAmount>
<TaxAmount>0.0</TaxAmount>
<Description>sample</Description>
<BillingAddress>
<FirstName>sample</FirstName>
<LastName>sample</LastName>
<CompanyName>sample</CompanyName>
<Address1>sample</Address1>
<Address2>sample</Address2>
<Address3>sample</Address3>
<Address4>sample</Address4>
<Address5>sample</Address5>
<Address6>sample</Address6>
<City>sample</City>
<State>sample</State>
<ZipCode>sample</ZipCode>
<Country>sample</Country>
<IsDefault xsi:nil="true"/>
<AddressId>sample</AddressId>
</BillingAddress>
<ShippingAddress>
<FirstName>sample</FirstName>
<LastName>sample</LastName>
<CompanyName>sample</CompanyName>
<Address1>sample</Address1>
<Address2>sample</Address2>
<Address3>sample</Address3>
<Address4>sample</Address4>
<Address5>sample</Address5>
<Address6>sample</Address6>
<City>sample</City>
<State>sample</State>
<ZipCode>sample</ZipCode>
<Country>sample</Country>
<IsDefault xsi:nil="true"/>
<AddressId>sample</AddressId>
</ShippingAddress>
<ApprovedURL>https:45s874s8/approved.html</ApprovedURL>
<DeclinedURL>https:78h3s47598/declined.html</DeclinedURL>
<ErrorURL>https://5xphs/error.html</ErrorURL>
<DisplayDefaultResultPage>0</DisplayDefaultResultPage>
<PayByType>CC,ACH</PayByType>
<AllowedPaymentMethods>sample</AllowedPaymentMethods>
<SavePaymentMethod xsi:nil="true"/>
<ShowSavedPaymentMethods xsi:nil="true"/>
<CountryCode>sample</CountryCode>
<CurrencyCode>sample</CurrencyCode>
<ProcessingCommand>Sale</ProcessingCommand>
<SoftwareId>EBCBC</SoftwareId>
<TransactionLookupKey>sample</TransactionLookupKey>
<LineItems>
<TransactionLineItem>
<ProductRefNum>Item 100</ProductRefNum>
<SKU>15255222</SKU>
<CommodityCode>sample</CommodityCode>
<ProductName>Blades</ProductName>
<Description>sample</Description>
<DiscountAmount>1.0</DiscountAmount>
<DiscountRate>1.0</DiscountRate>
<UnitOfMeasure>EA</UnitOfMeasure>
<UnitPrice>25.2</UnitPrice>
<Qty>1.0</Qty>
<Taxable xsi:nil="true"/>
<TaxAmount>0.0</TaxAmount>
<TaxRate>0.0</TaxRate>
</TransactionLineItem>
</LineItems>
<Clerk>BigCommerce</Clerk>
<Terminal>BigCommerce</Terminal>
<ShowViewInvoiceLink xsi:nil="true"/>
<InvoiceInternalId>sample</InvoiceInternalId>
<DeviceSettings>
<ShowDeviceList xsi:nil="true"/>
<DeviceKey/>
</DeviceSettings>
<DocumentTypeId>sample</DocumentTypeId>
<ShowViewSalesOrderLink xsi:nil="true"/>
<SalesOrderInternalId>sample</SalesOrderInternalId>
</EbizWebForm>
<PaymentInternalId>**************4bf0-91cd**************</PaymentInternalId>
<IsPaid>false</IsPaid>
<IsApplied>false</IsApplied>
<IsDeleted>false</IsDeleted>
<IsUpdated>false</IsUpdated>
<DateCreated>2026-04-08T10:17:01</DateCreated>
<DateLastUpdated/>
<DatePaid/>
<DateApplied/>
<DateDeleted/>
</EbizWebFormResult>
</Results>
<TotalCount>3</TotalCount>
<Start>0</Start>
<Limit>3</Limit>
<Status>Success</Status>
<StatusCode>1</StatusCode>
<Error/>
<ErrorCode>0</ErrorCode>
</SearchEbizWebFormResult>
</SearchEbizWebFormResponse>
</s:Body>
</s:Envelope><s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SearchEbizWebFormResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
<SearchEbizWebFormResult>
<Results/>
<TotalCount>0</TotalCount>
<Start>0</Start>
<Limit>3</Limit>
<Status>Error</Status>
<StatusCode>0</StatusCode>
<Error>General Error:Conversion failed when converting the nvarchar value 'true' to data type tinyint.</Error>
<ErrorCode>10</ErrorCode>
</SearchEbizWebFormResult>
</SearchEbizWebFormResponse>
</s:Body>
</s:Envelope>Updated 7 days ago