api/ARInvoiceEntry/Create (POST)
Creates a new AR Invoice Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields:
ARInvoiceEntry: INVOICE_TYPE
ARInvoiceEntryDetail: INV_LINE_TYPE
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created AR Invoice Entry Transaction.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing AR Invoice Entry Transaction creation data.
Create AR Invoice Entry Transaction Example:
{
"ARInvoiceEntry": {
"INVOICE_TYPE": "SI",
"SO_ID": "100446"
},
"ARInvoiceEntryDetail": [
{
"INV_LINE_TYPE": "SHIPMENT",
"SO_LINE_NO": "1",
"SHIPMENT_NO": "1",
"QUANTITY": "2",
"SO_UNIT_PRICE": "327.55"
},
{
"INV_LINE_TYPE": "FREIGHT",
"AMOUNT": "12.54"
},
{
"INV_LINE_TYPE": "OTHER",
"SO_DESC": "Extra Packaging",
"QUANTITY": "2",
"SO_UNIT_PRICE": "5"
}
]
}
Returns 1 AR Invoice Entry Transaction if successful.
Note: INVOICE_NUMBER is generated automatically by the API.
Accepted AR Invoice Entry Fields:
AR_COMPANY_ID, ARFIM_USER_1, ARFIM_USER_2, ARFIM_USER_3,
ARFIM_USER_4, ARFIM_USER_5, ARFIM_USER_6, ARFIM_USER_7,
ARFIM_USER_8, BANK_CODE, BATCH_NUMBER, BILL_TO_CUST,
CURR_RATE, CUST_PO_ID, DISCOUNT_AMT, DISCOUNT_DATE,
DISCOUNT_PCT, DUE_DATE, FOB, FREIGHT_CODE,
GL_MONTH, GL_YEAR, INVOICE_DATE, INVOICE_TYPE,
ORDER_DISC_PCT, ORDER_TAKER, PAYMENT_TYPE, REFERENCE,
SALES_REGION, SALESMAN_ID, SHIP_METHOD, SHIP_TO_CUST,
SHIPPED_DATE, SO_ID, TERMS_CODE
Accepted AR Invoice Entry Detail Fields:
AMOUNT, BILL_OF_LADING, COMPANY_ID, INV_LINE_TYPE,
ITEM_DISC_PCT, LINE_TAX_AMT, LINE_TAX_2, LINE_TAX_3,
LINE_TAX_4, LINE_TAX_5, LINE_TAX_6, LINE_TAX_7,
LINE_TAX_8, LINE_TAX_9, LINE_TAX_10, PART_ID,
PRICE_CODE, QUANTITY, REFERENCE_1, SALES_ACCT,
SALES_DEPT, SO_DESC, SO_LINE_NO, SO_UM,
SO_UNIT_PRICE, TAX_CODE, VAT_CODE |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON object with created AR Invoice Entry Transaction.
Error:
400/Request JSON is invalid.
400/Request has no Transaction Header.
400/Request has no Transaction Details.
400/Request Transaction Detail has no INV_LINE_TYPE.
400/INV_LINE_TYPE must be SHIPMENT, FREIGHT, or OTHER.
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 Invoice Entry Fields:
AR_COMPANY_ID, ARFIM_USER_1, ARFIM_USER_2, ARFIM_USER_3, ARFIM_USER_4, ARFIM_USER_5, ARFIM_USER_6, ARFIM_USER_7, ARFIM_USER_8, BANK_CODE, BASE_CURR, BATCH_NUMBER, BC_RATE, BILL_TO_CUST, CURR_CODE, CURR_RATE, CUST_PO_ID, CUSTOMER_ID, CUSTOMER_NAME, CUSTOMER_NAME_BillTo, CUSTOMER_NAME_ShipTo, DATE_LAST_EDI, DISCOUNT_AMT, DISCOUNT_DATE, DISCOUNT_PCT, DUE_DATE, FOB, FREIGHT_CODE, GL_MONTH, GL_YEAR, INVOICE_AMT, INVOICE_DATE, INVOICE_FRT_AMT, INVOICE_NUMBER, INVOICE_ORIG, INVOICE_TAX_AMT, INVOICE_TAX_2, INVOICE_TAX_3, INVOICE_TAX_4, INVOICE_TAX_5, INVOICE_TAX_6, INVOICE_TAX_7, INVOICE_TAX_8, INVOICE_TAX_9, INVOICE_TAX_10, INVOICE_TYPE, INVOICE_VAT, OPERATOR_ID, ORDER_DISC_AMT, ORDER_DISC_PCT, ORDER_SUBTOTAL, ORDER_TAKER, PAYMENT_TYPE, REFERENCE, SALES_REGION, SALESMAN_ID, SHIP_METHOD, SHIP_TO_CUST, SHIPPED_DATE, SO_ID, TERMS_CODE, TOTAL_BATCH_AMT, TOTAL_INVOICES
Returned AR Invoice Entry Detail Fields:
ACTION_TYPE, AMOUNT, BASE_PRICE, BILL_OF_LADING, COMPANY_ID, CURR_CODE, FOB, FREIGHT_CODE, INV_LINE_NO, INV_LINE_TYPE, ITEM_DISC_PCT, LINE_ORDER_DISC, LINE_TAX_AMT, LINE_TAX_2, LINE_TAX_3, LINE_TAX_4, LINE_TAX_5, LINE_TAX_6, LINE_TAX_7, LINE_TAX_8, LINE_TAX_9, LINE_TAX_10, LINE_VAT, NUMBER_CARTONS, PART_ID, PRICE_CODE, PROD_DISC_AMT1, PROD_DISC_AMT2, PROD_DISC_AMT3, PROD_DISC_CODE1, PROD_DISC_CODE2, PROD_DISC_CODE3, PROD_DISC_TOTAL, QUANTITY, REFERENCE_1, SALES_ACCT, SALES_DEPT, SHIP_METHOD, SHIP_TO_CUST, SHIPMENT_NO, SO_DESC, SO_LINE_NO, SO_UM, SO_UNIT_PRICE, TAX_CODE, VAT_CODE, WEIGHT