SWAPI – ARReceiptQuery

This command is used to query payments and deposits related to invoices they were collected on or applied to.

Request

<SessionRequest Version="string" SessionID="{506B2C09-C2E5-4C4D-B58E-AACBE1A1FBE7}" RequestID="string">

<ARReceiptQuery Filter="string" Max="string" OrderBy="string" StyleNo="string" StyleOptions="string">

<AR_ReceiptID>int</AR_ReceiptID>

</ARReceiptQuery>

</SessionRequest>

· AR_ReceiptID – The ID of the receipt record.

Response

<ARReceiptQueryData RequestID="string">

<ARReceiptQueryRecord>

<AR_ReceiptID>integer</AR_ReceiptID>

<AR_BillingCustomerID>integer</AR_BillingCustomerID>

<JobID>integer</JobID>

<InvoiceIDRecordedOn>integer</InvoiceIDRecordedOn>

<InvoiceIDAppliedTo>integer</InvoiceIDAppliedTo>

<ARReceiptType>string(8)</ARReceiptType>

<PaymentDate>dateTime</PaymentDate>

<PaymentAmount>float</PaymentAmount>

<PaymentType>string(15)</PaymentType>

<PaymentMethod>string(15)</PaymentMethod>

<CreditCardNumber>string(32)</CreditCardNumber>

<CreditCardExpireMonth>integer</CreditCardExpireMonth>

<CreditCardExpireYear>integer</CreditCardExpireYear>

<CreditCardName>string(40)</CreditCardName>

<PmtAuthorization>string(40)</PmtAuthorization>

<XCAlias>string(25)</XCAlias>

<RoutingNumber>string(40)</RoutingNumber>

<BankAccountNumber>string(32)</BankAccountNumber>

<CheckNumber>string(32)</CheckNumber>

<MobileRefID>string(80)</MobileRefID>

<Posted>boolean</Posted>

<SigPayment>bin.base64</SigPayment>

<Comment>string(35)</Comment>

<ModifiedBy>string(30)</ModifiedBy>

</ARReceiptQueryRecord>

</ARReceiptQueryData>

· AR_ReceiptID – The ID of the receipt record.

· AR_BillingCustomerID – The ID of the billing customer

· JobID – The ID of the related Job for the receipt

· InvoiceIDRecordedOn – The invoice the receipt was recorded on

· InvoiceIDAppliedTo – The invoice the receipt was or will be applied to

· ARReceitType – “payment” or “deposit”

· PaymentDate – Date of the receipt

· PaymentAmount – Amount of the receipt

· PaymentType – Payment Type

· PaymentMethod – Payment Method

· CreditCardNumber – used if receipt by credit card

· CreditCardExpireMonth – used if receipt by credit card

· CreditCardExpireYear – used if receipt by credit card

· CreditCardName – used if receipt by credit card

· PmtAuthorization – used if receipt by credit card

· XCAlias – used if receipt by credit card

· RoutingNumber – used if receipt by ACH

· BankAccountNumber – used if receipt by ACH

· CheckNumber – used if receipt by check

· MobileRefID – A reference ID from the mobile system

· Posted – The posted status of the receipt

· SigPayment – Signature related to the receipt

· Comment – Additional notes regarding the receipt

· ModifiedBy – The Successware user submitting the receipt