Expandable Web API - AR Remittance Entry, Create

AR Remittance Entry, Create

Creates a new AR Remittance Entry transaction using the supplied data and returns the details of the transaction.

URL

/api/ar-remittance-entry-create

Request Method

POST

Expandable Program

Remittance Entry (ARTRE)

Required Fields

HEADER:
CHECK_CUST
CHECK_ID
AUTH_TOKEN

PAYMENTS:
INVOICE_NUMBER
AMOUNT_PAID

CREDIT_MEMOS:
INVOICE_NUMBER
INVOICE_LN_AMT

DEBIT_MEMOS:
INVOICE_NUMBER
INVOICE_LN_AMT

MISC_CASH:
DEPARTMENT
ACCOUNT
AMOUNT

Auth Token

This API call requires an Authentication Token ("Auth Token") for the required field AUTH_TOKEN. Auth Tokens are obtained from Auth Token, Get.

Example Request JSON

{
  "BANK_CODE": "BA",
  "CHECK_CUST": "ABCCORP",
  "CHECK_ID": "00007391",
  "CHECK_TYPE": "C",
  "CHECK_DATE": "2016-03-16",
  "ABA_NUMBER": "122105278",
  "DATE_RECEIVED": "2016-03-22",
  "CHECK_AMOUNT": "1000",
  "COMMENT_1": "mailed handwritten check",
  "PAYMENTS": [
    {
      "INVOICE_NUMBER": "901",
      "AMOUNT_PAID": "300",
      "DISCOUNT_TAKEN": "0",
      "DISCOUNT_LOST": "0"
  }
  ],
  "CREDIT_MEMOS" : [
    {
      "INVOICE_NUMBER": "901",
      "INVOICE_LN_AMT": "-10.00"
    }
  ],
  "DEBIT_MEMOS" : [
    {
      "INVOICE_NUMBER": "901",
      "INVOICE_LN_AMT": "10.00"
    }
  ],    
  "MISC_CASH": [
    {
      "DEPARTMENT": "0",
      "ACCOUNT": "165",
      "AMOUNT": "-300.00"
    },
    {
      "DEPARTMENT": "0",
      "ACCOUNT": "130",
      "AMOUNT": "-410.00"
    }
  ],
  "AUTH_TOKEN": ""
}

Full Request JSON

{
  "GL_MONTH": "",
  "GL_YEAR": "",
  "BANK_CODE": "",
  "AR_COMPANY_ID": "",
  "CHECK_CUST": "",
  "CHECK_ID": "",
  "CHECK_TYPE": "",
  "CHECK_DATE": "",
  "ABA_NUMBER": "",
  "DATE_RECEIVED": "",
  "CHECK_AMOUNT": "",
  "COMMENT_1": "",
  "COMMENT_2": "",
  "BATCH_NUMBER": "",
  "TXNS_ACCEPTED": "",
  "BILL_TO_CUST": "",
  "PAYMENTS": [
    {
      "INVOICE_NUMBER": "",
      "AMOUNT_PAID": "",
      "DISCOUNT_TAKEN": "",
      "DISCOUNT_LOST": ""
    }
  ],
  "CREDIT_MEMOS": [
    {
      "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": ""
    }
  ],
  "DEBIT_MEMOS": [
    {
      "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": ""
    }
  ],
  "MISC_CASH": [
    {
      "DEPARTMENT": "",
      "ACCOUNT": "",
      "AMOUNT": ""
    }
  ],
  "AUTH_TOKEN": ""
}

Batch Numbers

This transaction uses Batch Numbers. Batch Numbers are specified in the BATCH_NUMBER field. Normally a new Batch Number is assigned automatically by the transaction every time it is called and this Batch Number is returned by the transaction.

It is also possible use the same Batch Number across multiple transactions. This is done by passing the Batch Number that is returned from the first call into subsequent calls. This has the advantage of relating multiple transactions to each other, and consuming less Batch Numbers in the system. The scope of what constitutes a "Batch" is up to the API client application developer. In Expandable, the scope of a "Batch" is considered to include all transactions entered by a single operator before closing the transaction window.

Success Response

Returned HTTP status indicates success:

200/OK

Returned JSON contains the details of the successful transaction:

{
  "GL_MONTH": "",
  "GL_YEAR": "",
  "BANK_CODE": "",
  "AR_COMPANY_ID": "",
  "CHECK_CUST": "",
  "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": "",
  "TXNS_ACCEPTED": "",
  "BILL_TO_CUST": "",
  "APPLIED_ITEMS": [
    {
      "APPLIED_TYPE": "",
      "CUSTOMER_ID": "",
      "INV_OR_MEMO_NUM": "",
      "APPLIED_AMOUNT": "",
      "CREDIT_AMT": ""
    }
  ],
  "AUTH_TOKEN": ""
}

Failure Response

Returned HTTP status indicates failure:

400/Request JSON is invalid.
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/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)

Returned JSON contains error information for the failed transaction:

{
  "MESSAGE": "",
  "MESSAGE_CODE": ""
}

Try the API