POST api/SetupARServiceInvoices/GetInvoicesBySmId
Request Information
URI Parameters
None.
Body Parameters
ARServiceInvoicesSearchCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| IsServiceInvoice | boolean |
None. |
|
| ServiceMasterId | string |
None. |
|
| ARCustomerMasterId | string |
None. |
|
| Batch | string |
None. |
|
| IsAllInvoices | boolean |
None. |
|
| FromDate | date |
None. |
|
| ToDate | date |
None. |
|
| InvoiceType | string |
None. |
|
| Keyword | string |
None. |
|
| AccountId | integer |
None. |
|
| CompanyId | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedOn | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"IsServiceInvoice": true,
"ServiceMasterId": "sample string 2",
"ARCustomerMasterId": "sample string 3",
"Batch": "sample string 4",
"IsAllInvoices": true,
"FromDate": "2025-12-16T14:46:58.2904946+00:00",
"ToDate": "2025-12-16T14:46:58.2904946+00:00",
"InvoiceType": "sample string 6",
"Keyword": "sample string 7",
"AccountId": 8,
"CompanyId": "sample string 9",
"CreatedBy": "sample string 10",
"CreatedOn": "2025-12-16T14:46:58.2904946+00:00"
}
application/xml, text/xml
Sample:
<ARServiceInvoicesSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.AR"> <AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">8</AccountId> <CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 9</CompanyId> <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 10</CreatedBy> <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T14:46:58.2904946+00:00</CreatedOn> <ARCustomerMasterId>sample string 3</ARCustomerMasterId> <Batch>sample string 4</Batch> <FromDate>2025-12-16T14:46:58.2904946+00:00</FromDate> <InvoiceType>sample string 6</InvoiceType> <IsAllInvoices>true</IsAllInvoices> <IsServiceInvoice>true</IsServiceInvoice> <Keyword>sample string 7</Keyword> <ServiceMasterId>sample string 2</ServiceMasterId> <ToDate>2025-12-16T14:46:58.2904946+00:00</ToDate> </ARServiceInvoicesSearchCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
InvoiceListForPayment| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceEntities | Collection of InvoiceForPayment |
None. |
|
| FooterText | string |
None. |
|
| AccountId | integer |
None. |
|
| CompanyId | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedOn | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"InvoiceEntities": [
{
"InvoiceNum": "sample string 1",
"InvoiceDate": "2025-12-16T14:46:58.2904946+00:00",
"InvoiceDueDate": "2025-12-16T14:46:58.2904946+00:00",
"ARCustomerMasterId": "sample string 4",
"SDServiceMasterId": "sample string 5",
"SDCallMasterId": "sample string 6",
"ARName": "sample string 7",
"SMName": "sample string 8",
"Email": "sample string 9",
"InvoiceTotal": 10.0,
"Status": "sample string 11",
"BalanceDueAmount": 12.0,
"IsServiceInvoice": true,
"PaymentStatus": "sample string 14",
"PaymentStatusDetail": "sample string 15",
"ErrorMessage": "sample string 16",
"AuthCode": "sample string 17",
"Receipt": "sample string 18",
"CallOutcomeCodeType": "sample string 19",
"CreditCardDetail": {
"Id": 1,
"ARCustomerMasterId": "sample string 1",
"CardNumber": "sample string 2",
"CardType": "sample string 3",
"CardExpiryMonth": "sample string 4",
"CardExpiryYear": "sample string 5",
"CardCompanyName": "sample string 6",
"LocationMasterId": 1,
"AddressLine1": "sample string 7",
"ZipCode": "sample string 8",
"CardCVV": "sample string 9",
"CardHolderName": "sample string 10",
"EmailAddressToSendReceipt": "sample string 11",
"CardLabel": "sample string 12",
"Notes": "sample string 13",
"Last4Digits": "sample string 14",
"SaveCardInfoForFutureUse": true,
"HostedPaymentsAccountId": "sample string 16",
"SelectedPaymentGateway": "sample string 17",
"EncryptedEmvTerminalCardData": "sample string 18",
"PaymentSourceType": "sample string 19",
"Type": "sample string 20",
"TypeId": "sample string 21",
"AccountId": 22,
"CompanyId": "sample string 23",
"CreatedBy": "sample string 24",
"CreatedOn": "2025-12-16T14:46:58.308327+00:00"
},
"IsContractInvoice": true,
"HostedPaymentsAccountId": "sample string 21",
"TransactionId": "sample string 22",
"SaveInWallet": true,
"InvoiceSeqNum": "sample string 24",
"IsApproved": true,
"AccountId": 26,
"CompanyId": "sample string 27",
"CreatedBy": "sample string 28",
"CreatedOn": "2025-12-16T14:46:58.308327+00:00"
},
{
"InvoiceNum": "sample string 1",
"InvoiceDate": "2025-12-16T14:46:58.2904946+00:00",
"InvoiceDueDate": "2025-12-16T14:46:58.2904946+00:00",
"ARCustomerMasterId": "sample string 4",
"SDServiceMasterId": "sample string 5",
"SDCallMasterId": "sample string 6",
"ARName": "sample string 7",
"SMName": "sample string 8",
"Email": "sample string 9",
"InvoiceTotal": 10.0,
"Status": "sample string 11",
"BalanceDueAmount": 12.0,
"IsServiceInvoice": true,
"PaymentStatus": "sample string 14",
"PaymentStatusDetail": "sample string 15",
"ErrorMessage": "sample string 16",
"AuthCode": "sample string 17",
"Receipt": "sample string 18",
"CallOutcomeCodeType": "sample string 19",
"CreditCardDetail": {
"Id": 1,
"ARCustomerMasterId": "sample string 1",
"CardNumber": "sample string 2",
"CardType": "sample string 3",
"CardExpiryMonth": "sample string 4",
"CardExpiryYear": "sample string 5",
"CardCompanyName": "sample string 6",
"LocationMasterId": 1,
"AddressLine1": "sample string 7",
"ZipCode": "sample string 8",
"CardCVV": "sample string 9",
"CardHolderName": "sample string 10",
"EmailAddressToSendReceipt": "sample string 11",
"CardLabel": "sample string 12",
"Notes": "sample string 13",
"Last4Digits": "sample string 14",
"SaveCardInfoForFutureUse": true,
"HostedPaymentsAccountId": "sample string 16",
"SelectedPaymentGateway": "sample string 17",
"EncryptedEmvTerminalCardData": "sample string 18",
"PaymentSourceType": "sample string 19",
"Type": "sample string 20",
"TypeId": "sample string 21",
"AccountId": 22,
"CompanyId": "sample string 23",
"CreatedBy": "sample string 24",
"CreatedOn": "2025-12-16T14:46:58.308327+00:00"
},
"IsContractInvoice": true,
"HostedPaymentsAccountId": "sample string 21",
"TransactionId": "sample string 22",
"SaveInWallet": true,
"InvoiceSeqNum": "sample string 24",
"IsApproved": true,
"AccountId": 26,
"CompanyId": "sample string 27",
"CreatedBy": "sample string 28",
"CreatedOn": "2025-12-16T14:46:58.308327+00:00"
}
],
"FooterText": "sample string 1",
"AccountId": 2,
"CompanyId": "sample string 3",
"CreatedBy": "sample string 4",
"CreatedOn": "2025-12-16T14:46:58.308327+00:00"
}
application/xml, text/xml
Sample:
<InvoiceListForPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.AR">
<AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2</AccountId>
<CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 3</CompanyId>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 4</CreatedBy>
<CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T14:46:58.308327+00:00</CreatedOn>
<FooterText>sample string 1</FooterText>
<InvoiceEntities>
<InvoiceForPayment>
<AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">26</AccountId>
<CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 27</CompanyId>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 28</CreatedBy>
<CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T14:46:58.308327+00:00</CreatedOn>
<ARCustomerMasterId>sample string 4</ARCustomerMasterId>
<ARName>sample string 7</ARName>
<AuthCode>sample string 17</AuthCode>
<BalanceDueAmount>12</BalanceDueAmount>
<CallOutcomeCodeType>sample string 19</CallOutcomeCodeType>
<CreditCardDetail>
<AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">22</AccountId>
<CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 23</CompanyId>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 24</CreatedBy>
<CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T14:46:58.308327+00:00</CreatedOn>
<ARCustomerMasterId>sample string 1</ARCustomerMasterId>
<AddressLine1>sample string 7</AddressLine1>
<CardCVV>sample string 9</CardCVV>
<CardCompanyName>sample string 6</CardCompanyName>
<CardExpiryMonth>sample string 4</CardExpiryMonth>
<CardExpiryYear>sample string 5</CardExpiryYear>
<CardHolderName>sample string 10</CardHolderName>
<CardLabel>sample string 12</CardLabel>
<CardNumber>sample string 2</CardNumber>
<CardType>sample string 3</CardType>
<EmailAddressToSendReceipt>sample string 11</EmailAddressToSendReceipt>
<EncryptedEmvTerminalCardData>sample string 18</EncryptedEmvTerminalCardData>
<HostedPaymentsAccountId>sample string 16</HostedPaymentsAccountId>
<Id>1</Id>
<Last4Digits>sample string 14</Last4Digits>
<LocationMasterId>1</LocationMasterId>
<Notes>sample string 13</Notes>
<PaymentSourceType>sample string 19</PaymentSourceType>
<SaveCardInfoForFutureUse>true</SaveCardInfoForFutureUse>
<SelectedPaymentGateway>sample string 17</SelectedPaymentGateway>
<Type>sample string 20</Type>
<TypeId>sample string 21</TypeId>
<ZipCode>sample string 8</ZipCode>
</CreditCardDetail>
<Email>sample string 9</Email>
<ErrorMessage>sample string 16</ErrorMessage>
<HostedPaymentsAccountId>sample string 21</HostedPaymentsAccountId>
<InvoiceDate>2025-12-16T14:46:58.2904946+00:00</InvoiceDate>
<InvoiceDueDate>2025-12-16T14:46:58.2904946+00:00</InvoiceDueDate>
<InvoiceNum>sample string 1</InvoiceNum>
<InvoiceSeqNum>sample string 24</InvoiceSeqNum>
<InvoiceTotal>10</InvoiceTotal>
<IsApproved>true</IsApproved>
<IsContractInvoice>true</IsContractInvoice>
<IsServiceInvoice>true</IsServiceInvoice>
<PaymentStatus>sample string 14</PaymentStatus>
<PaymentStatusDetail>sample string 15</PaymentStatusDetail>
<Receipt>sample string 18</Receipt>
<SDCallMasterId>sample string 6</SDCallMasterId>
<SDServiceMasterId>sample string 5</SDServiceMasterId>
<SMName>sample string 8</SMName>
<SaveInWallet>true</SaveInWallet>
<Status>sample string 11</Status>
<TransactionId>sample string 22</TransactionId>
</InvoiceForPayment>
<InvoiceForPayment>
<AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">26</AccountId>
<CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 27</CompanyId>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 28</CreatedBy>
<CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T14:46:58.308327+00:00</CreatedOn>
<ARCustomerMasterId>sample string 4</ARCustomerMasterId>
<ARName>sample string 7</ARName>
<AuthCode>sample string 17</AuthCode>
<BalanceDueAmount>12</BalanceDueAmount>
<CallOutcomeCodeType>sample string 19</CallOutcomeCodeType>
<CreditCardDetail>
<AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">22</AccountId>
<CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 23</CompanyId>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 24</CreatedBy>
<CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T14:46:58.308327+00:00</CreatedOn>
<ARCustomerMasterId>sample string 1</ARCustomerMasterId>
<AddressLine1>sample string 7</AddressLine1>
<CardCVV>sample string 9</CardCVV>
<CardCompanyName>sample string 6</CardCompanyName>
<CardExpiryMonth>sample string 4</CardExpiryMonth>
<CardExpiryYear>sample string 5</CardExpiryYear>
<CardHolderName>sample string 10</CardHolderName>
<CardLabel>sample string 12</CardLabel>
<CardNumber>sample string 2</CardNumber>
<CardType>sample string 3</CardType>
<EmailAddressToSendReceipt>sample string 11</EmailAddressToSendReceipt>
<EncryptedEmvTerminalCardData>sample string 18</EncryptedEmvTerminalCardData>
<HostedPaymentsAccountId>sample string 16</HostedPaymentsAccountId>
<Id>1</Id>
<Last4Digits>sample string 14</Last4Digits>
<LocationMasterId>1</LocationMasterId>
<Notes>sample string 13</Notes>
<PaymentSourceType>sample string 19</PaymentSourceType>
<SaveCardInfoForFutureUse>true</SaveCardInfoForFutureUse>
<SelectedPaymentGateway>sample string 17</SelectedPaymentGateway>
<Type>sample string 20</Type>
<TypeId>sample string 21</TypeId>
<ZipCode>sample string 8</ZipCode>
</CreditCardDetail>
<Email>sample string 9</Email>
<ErrorMessage>sample string 16</ErrorMessage>
<HostedPaymentsAccountId>sample string 21</HostedPaymentsAccountId>
<InvoiceDate>2025-12-16T14:46:58.2904946+00:00</InvoiceDate>
<InvoiceDueDate>2025-12-16T14:46:58.2904946+00:00</InvoiceDueDate>
<InvoiceNum>sample string 1</InvoiceNum>
<InvoiceSeqNum>sample string 24</InvoiceSeqNum>
<InvoiceTotal>10</InvoiceTotal>
<IsApproved>true</IsApproved>
<IsContractInvoice>true</IsContractInvoice>
<IsServiceInvoice>true</IsServiceInvoice>
<PaymentStatus>sample string 14</PaymentStatus>
<PaymentStatusDetail>sample string 15</PaymentStatusDetail>
<Receipt>sample string 18</Receipt>
<SDCallMasterId>sample string 6</SDCallMasterId>
<SDServiceMasterId>sample string 5</SDServiceMasterId>
<SMName>sample string 8</SMName>
<SaveInWallet>true</SaveInWallet>
<Status>sample string 11</Status>
<TransactionId>sample string 22</TransactionId>
</InvoiceForPayment>
</InvoiceEntities>
</InvoiceListForPayment>