api/ARRemittanceEntry/Create (POST)

Creates a new AR Remittance Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields:
ARRemittanceEntry: CHECK_CUST, CHECK_ID
ARRemittanceEntryPayment: INVOICE_NUMBER, AMOUNT_PAID
ARRemittanceEntryCreditMemo: INVOICE_NUMBER, INVOICE_LN_AMT
ARRemittanceEntryDebitMemo: INVOICE_NUMBER, INVOICE_LN_AMT
ARRemittanceEntryMiscCash: DEPARTMENT, ACCOUNT, AMOUNT
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created AR Remittance Entry Transaction.

Request Information

Parameters

NameDescriptionAdditional information
RequestData 
This is a JSON object containing AR Remittance Entry Transaction creation data.

Create AR Remittance Entry Transaction Example:
{
  "ARRemittanceEntry": {
    "BANK_CODE": "BA",
    "CHECK_CUST": "ABCCORP",
    "CHECK_ID": "00007391",
    "CHECK_TYPE": "C",
    "CHECK_DATE": "3/16/2016",
    "ABA_NUMBER": "122105278",
    "DATE_RECEIVED": "3/22/2016",
    "CHECK_AMOUNT": "1000",
    "COMMENT_1": "mailed handwritten check"
  },
  "ARRemittanceEntryPayment": [
    {
      "INVOICE_NUMBER": "901",
      "AMOUNT_PAID": "300",
      "DISCOUNT_TAKEN": "0",
      "DISCOUNT_LOST": "0"
  }
  ],
  "ARRemittanceEntryCreditMemo" : [
    {
      "INVOICE_NUMBER": "901",
      "INVOICE_LN_AMT": "-10.00"
    }
  ],
  "ARRemittanceEntryDebitMemo" : [
    {
      "INVOICE_NUMBER": "901",
      "INVOICE_LN_AMT": "10.00"
    }
  ],    
  "ARRemittanceEntryMiscCash": [
    {
      "DEPARTMENT": "0",
      "ACCOUNT": "165",
      "AMOUNT": "-300.00"
    },
    {
      "DEPARTMENT": "0",
      "ACCOUNT": "130",
      "AMOUNT": "-410.00"
    }
  ]
}
Returns 1 AR Remittance Entry Transaction if successful.

Accepted AR Remittance Entry Fields:
GL_MONTH, GL_YEAR, BANK_CODE, AR_COMPANY_ID, 
CHECK_CUST, CHECK_ID, CHECK_TYPE, CHECK_DATE, 
ABA_NUMBER, DATE_RECEIVED, CHECK_AMOUNT, CHECK_RATE, 
COMMENT_1, COMMENT_2, BILL_TO_CUST

Accepted AR Remittance Entry Payment Fields:
INVOICE_NUMBER, AMOUNT_PAID, DISCOUNT_TAKEN, DISCOUNT_LOST

Accepted AR Remittance Entry Credit Memo Fields:
INVOICE_NUMBER, REMARK, SO_DESC, COMPANY_ID, 
SALES_DEPT, SALES_ACCT, INVOICE_LN_AMT, TAX_CODE, 
VAT_CODE, MEMO_DISC_AMT, MEMO_DUE_DATE, COMMENT_TEXT

Accepted AR Remittance Entry Debit Memo Fields:
INVOICE_NUMBER, REFERENCE, REMARK, SO_DESC, 
COMPANY_ID, SALES_DEPT, SALES_ACCT, INVOICE_LN_AMT, 
TAX_CODE, VAT_CODE, MEMO_DISC_AMT, MEMO_DUE_DATE, 
COMMENT_TEXT

Accepted AR Remittance Entry Misc Cash Fields:
DEPARTMENT, ACCOUNT, AMOUNT

Define this parameter in the request body.

Response Information

Success:
200/OK
Body contains JSON object with created AR Remittance Entry Transaction.

Error:
400/Request JSON is invalid.
400/Request has no Transaction Header.
400/Request has no Payments or Misc Cash.
400/Request has Credit Memos but no Payments.
400/Request has Debit Memos but no Payments.
400/Request Payment has no INVOICE_NUMBER.
400/Request Credit Memo has no INVOICE_NUMBER.
400/Request Debit Memo has no INVOICE_NUMBER.
400/Request Misc Cash has no DEPARTMENT.
400/Request Misc Cash has no ACCOUNT.
400/Request Misc Cash has no AMOUNT.
401/AuthToken was not provided.
401/AuthToken is malformed.
401/AuthToken is expired.
401/AuthToken login failure.
500/(Message)
Body contains JSON object with Message and MessageCode.

Returned AR Remittance Entry Fields:
GL_MONTH, GL_YEAR, BANK_CODE, AR_COMPANY_ID, CHECK_CUST, CUSTOMER_NAME_Check, CUSTOMER_TYPE, CHECK_ID, CHECK_TYPE, CHECK_DATE, ABA_NUMBER, DATE_RECEIVED, CHECK_AMOUNT, CHECK_CURR, CHECK_RATE, CHECK_BALANCE, BANKCHG_AMT, COMMENT_1, COMMENT_2, BATCH_NUMBER, AMOUNT_FIELD_1, TXNS_ACCEPTED, BILL_TO_CUST, CUSTOMER_NAME_BillTo, OPERATOR_ID

Returned AR Invoice Entry Applied Item Fields:
APPLIED_TYPE, CUSTOMER_ID, INV_OR_MEMO_NUM, APPLIED_AMOUNT, CREDIT_AMT