POST api/SetupARServiceInvoices/PayInvoices

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
IsServiceInvoice	boolean	None.
InvoiceEntities	Collection of ARInvoicesToCharge	None.
AccountId	integer	None.
CompanyId	string	None.
CreatedBy	string	None.
CreatedOn	date	None.

Request Formats

application/json, text/json

Sample:

{
  "IsServiceInvoice": true,
  "InvoiceEntities": [
    {
      "ARCustomerMasterId": "sample string 1",
      "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-16T21:53:05.6556048+00:00"
      },
      "UserId": 2,
      "UserName": "sample string 3",
      "InvoicesToCharge": [
        {
          "InvoiceNum": "sample string 1",
          "AmountToCharge": 2.0,
          "Email": "sample string 3",
          "AuthCode": "sample string 4",
          "Result": "sample string 5",
          "Reference": "sample string 6",
          "AuthMessage": "sample string 7",
          "InvoiceInfoSeqNum": 8,
          "MockContractIds": [
            "sample string 1",
            "sample string 2"
          ],
          "MockContractTotal": 9.0
        },
        {
          "InvoiceNum": "sample string 1",
          "AmountToCharge": 2.0,
          "Email": "sample string 3",
          "AuthCode": "sample string 4",
          "Result": "sample string 5",
          "Reference": "sample string 6",
          "AuthMessage": "sample string 7",
          "InvoiceInfoSeqNum": 8,
          "MockContractIds": [
            "sample string 1",
            "sample string 2"
          ],
          "MockContractTotal": 9.0
        }
      ],
      "HostedPaymentsAccountId": "sample string 4",
      "HostedPaymentsResponse": "sample string 5",
      "LockedBy": "sample string 6",
      "AccountId": 7,
      "CompanyId": "sample string 8",
      "CreatedBy": "sample string 9",
      "CreatedOn": "2025-12-16T21:53:05.6750904+00:00"
    },
    {
      "ARCustomerMasterId": "sample string 1",
      "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-16T21:53:05.6556048+00:00"
      },
      "UserId": 2,
      "UserName": "sample string 3",
      "InvoicesToCharge": [
        {
          "InvoiceNum": "sample string 1",
          "AmountToCharge": 2.0,
          "Email": "sample string 3",
          "AuthCode": "sample string 4",
          "Result": "sample string 5",
          "Reference": "sample string 6",
          "AuthMessage": "sample string 7",
          "InvoiceInfoSeqNum": 8,
          "MockContractIds": [
            "sample string 1",
            "sample string 2"
          ],
          "MockContractTotal": 9.0
        },
        {
          "InvoiceNum": "sample string 1",
          "AmountToCharge": 2.0,
          "Email": "sample string 3",
          "AuthCode": "sample string 4",
          "Result": "sample string 5",
          "Reference": "sample string 6",
          "AuthMessage": "sample string 7",
          "InvoiceInfoSeqNum": 8,
          "MockContractIds": [
            "sample string 1",
            "sample string 2"
          ],
          "MockContractTotal": 9.0
        }
      ],
      "HostedPaymentsAccountId": "sample string 4",
      "HostedPaymentsResponse": "sample string 5",
      "LockedBy": "sample string 6",
      "AccountId": 7,
      "CompanyId": "sample string 8",
      "CreatedBy": "sample string 9",
      "CreatedOn": "2025-12-16T21:53:05.6750904+00:00"
    }
  ],
  "AccountId": 2,
  "CompanyId": "sample string 3",
  "CreatedBy": "sample string 4",
  "CreatedOn": "2025-12-16T21:53:05.6750904+00:00"
}

application/xml, text/xml

Sample:

<InvoiceEntityList 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-16T21:53:05.6750904+00:00</CreatedOn>
  <InvoiceEntities>
    <ARInvoicesToCharge>
      <AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">7</AccountId>
      <CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 8</CompanyId>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 9</CreatedBy>
      <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T21:53:05.6750904+00:00</CreatedOn>
      <ARCustomerMasterId>sample string 1</ARCustomerMasterId>
      <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-16T21:53:05.6556048+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>
      <HostedPaymentsAccountId>sample string 4</HostedPaymentsAccountId>
      <HostedPaymentsResponse>sample string 5</HostedPaymentsResponse>
      <InvoicesToCharge>
        <ARInvoiceToCharge>
          <AmountToCharge>2</AmountToCharge>
          <AuthCode>sample string 4</AuthCode>
          <AuthMessage>sample string 7</AuthMessage>
          <Email>sample string 3</Email>
          <InvoiceInfoSeqNum>8</InvoiceInfoSeqNum>
          <InvoiceNum>sample string 1</InvoiceNum>
          <MockContractIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </MockContractIds>
          <MockContractTotal>9</MockContractTotal>
          <Reference>sample string 6</Reference>
          <Result>sample string 5</Result>
        </ARInvoiceToCharge>
        <ARInvoiceToCharge>
          <AmountToCharge>2</AmountToCharge>
          <AuthCode>sample string 4</AuthCode>
          <AuthMessage>sample string 7</AuthMessage>
          <Email>sample string 3</Email>
          <InvoiceInfoSeqNum>8</InvoiceInfoSeqNum>
          <InvoiceNum>sample string 1</InvoiceNum>
          <MockContractIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </MockContractIds>
          <MockContractTotal>9</MockContractTotal>
          <Reference>sample string 6</Reference>
          <Result>sample string 5</Result>
        </ARInvoiceToCharge>
      </InvoicesToCharge>
      <LockedBy>sample string 6</LockedBy>
      <UserId>2</UserId>
      <UserName>sample string 3</UserName>
    </ARInvoicesToCharge>
    <ARInvoicesToCharge>
      <AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">7</AccountId>
      <CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 8</CompanyId>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 9</CreatedBy>
      <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T21:53:05.6750904+00:00</CreatedOn>
      <ARCustomerMasterId>sample string 1</ARCustomerMasterId>
      <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-16T21:53:05.6556048+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>
      <HostedPaymentsAccountId>sample string 4</HostedPaymentsAccountId>
      <HostedPaymentsResponse>sample string 5</HostedPaymentsResponse>
      <InvoicesToCharge>
        <ARInvoiceToCharge>
          <AmountToCharge>2</AmountToCharge>
          <AuthCode>sample string 4</AuthCode>
          <AuthMessage>sample string 7</AuthMessage>
          <Email>sample string 3</Email>
          <InvoiceInfoSeqNum>8</InvoiceInfoSeqNum>
          <InvoiceNum>sample string 1</InvoiceNum>
          <MockContractIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </MockContractIds>
          <MockContractTotal>9</MockContractTotal>
          <Reference>sample string 6</Reference>
          <Result>sample string 5</Result>
        </ARInvoiceToCharge>
        <ARInvoiceToCharge>
          <AmountToCharge>2</AmountToCharge>
          <AuthCode>sample string 4</AuthCode>
          <AuthMessage>sample string 7</AuthMessage>
          <Email>sample string 3</Email>
          <InvoiceInfoSeqNum>8</InvoiceInfoSeqNum>
          <InvoiceNum>sample string 1</InvoiceNum>
          <MockContractIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </MockContractIds>
          <MockContractTotal>9</MockContractTotal>
          <Reference>sample string 6</Reference>
          <Result>sample string 5</Result>
        </ARInvoiceToCharge>
      </InvoicesToCharge>
      <LockedBy>sample string 6</LockedBy>
      <UserId>2</UserId>
      <UserName>sample string 3</UserName>
    </ARInvoicesToCharge>
  </InvoiceEntities>
  <IsServiceInvoice>true</IsServiceInvoice>
</InvoiceEntityList>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ARInvoiceToCharge

Name	Type	Additional information
InvoiceNum	string	None.
AmountToCharge	decimal number	None.
Email	string	None.
AuthCode	string	None.
Result	string	None.
Reference	string	None.
AuthMessage	string	None.
InvoiceInfoSeqNum	integer	None.
MockContractIds	Collection of string	None.
MockContractTotal	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "InvoiceNum": "sample string 1",
    "AmountToCharge": 2.0,
    "Email": "sample string 3",
    "AuthCode": "sample string 4",
    "Result": "sample string 5",
    "Reference": "sample string 6",
    "AuthMessage": "sample string 7",
    "InvoiceInfoSeqNum": 8,
    "MockContractIds": [
      "sample string 1",
      "sample string 2"
    ],
    "MockContractTotal": 9.0
  },
  {
    "InvoiceNum": "sample string 1",
    "AmountToCharge": 2.0,
    "Email": "sample string 3",
    "AuthCode": "sample string 4",
    "Result": "sample string 5",
    "Reference": "sample string 6",
    "AuthMessage": "sample string 7",
    "InvoiceInfoSeqNum": 8,
    "MockContractIds": [
      "sample string 1",
      "sample string 2"
    ],
    "MockContractTotal": 9.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfARInvoiceToCharge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.AR">
  <ARInvoiceToCharge>
    <AmountToCharge>2</AmountToCharge>
    <AuthCode>sample string 4</AuthCode>
    <AuthMessage>sample string 7</AuthMessage>
    <Email>sample string 3</Email>
    <InvoiceInfoSeqNum>8</InvoiceInfoSeqNum>
    <InvoiceNum>sample string 1</InvoiceNum>
    <MockContractIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </MockContractIds>
    <MockContractTotal>9</MockContractTotal>
    <Reference>sample string 6</Reference>
    <Result>sample string 5</Result>
  </ARInvoiceToCharge>
  <ARInvoiceToCharge>
    <AmountToCharge>2</AmountToCharge>
    <AuthCode>sample string 4</AuthCode>
    <AuthMessage>sample string 7</AuthMessage>
    <Email>sample string 3</Email>
    <InvoiceInfoSeqNum>8</InvoiceInfoSeqNum>
    <InvoiceNum>sample string 1</InvoiceNum>
    <MockContractIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </MockContractIds>
    <MockContractTotal>9</MockContractTotal>
    <Reference>sample string 6</Reference>
    <Result>sample string 5</Result>
  </ARInvoiceToCharge>
</ArrayOfARInvoiceToCharge>