Customer Receipt API

Note: This update represents only a portion of the AMS360 24R1 release. Please navigate to AMS360 2024 R1 Release Notes to review other enhancements and fixes that were part of this release.

An agency can now use a third-party vendor for payments, where the vendor can send information to create a receipt within AMS360 as soon as the insured pays the invoice.

POST / receipt / customer

This element contains the customer number plus a list of invoices. There must be at least one invoice for each request, with amounts applied toward invoice balances.

CustomerCashReceiptPostRequest

  • customerNumber (integer): Customer number who made the payments for the invoices

  • invoiceInformations (Array[InvoiceInfoModel]): List of invoices where the payment should be applied; it must contain at least one item, even if the invoice number is not available.

  • receiptAmount (number): The payee's payment amount; the amount may not be zero or negative.

  • receiptDate (string): The date a payment was received from the customer. This is a date-only property; if time-of-day is also included, that data will be truncated.

  • receiptDateTimeZone (string): The time zone for ReceiptDate, where the time zone should reflect the local time where the API request was made.

  • bankShortName (string): Shortname for the bank where the payment receipt is posted. This element requires the API user to have access to the bank division and the bank.

  • receiptDescription (string, optional): Description for the payment received; if not provided, it will be generated.

  • paymentCheckType (string): The form of payment by the customer, where valid values include the following:

    • H or Check for check payment

    • A or Cash for cash payment

    • R or CreditCard for credit card payment

    • D or DebitCard for debit card payment

    • E or EFT for Electronic Funds Transfer.

  • payerBankAccountNumber (string, optional): Customer bank account number, from where the check was issued; this element it is ignored unless the PaymentCheckType is "Check."

  • payerCheckNumber (string, optional): Check number from the customer's payment; this element is ignored unless the PaymentCheckType is "Check."

InvoiceInfoModel

  • {invoiceNumber (integer, optional): Invoice number issued from AMS360. If an invoice number is not supplied, the amount will be applied to the customer's On Account. An invoice number generated for a multi-entity policy may contain a dash, followed by sequencing number. Please provide the number before the dash. For example, if the invoice number is 1234-1, only the first portion [1234] is the valid invoice number.

  • paymentAmount (number): Payment amount being applied toward invoice balance, which must be greater than zero. If the invoice being paid has already been paid in full, the entire payment amount for the invoice will be applied to "On Account."

  • invoicePaymentDescription (string, optional): The description for the invoice and payment being made; if this information is not provided, it will be generated.