regis

<back to all web services

FinanceCreateSaleRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Dynamics/CreateSale/{regent_id}
FinanceCreateSaleRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idpathintNo
amountbodydecimalNo
codebodystringNo
rebate_codebodystringNo
rebate_amountbodydecimal?No
payment_idbodystringNo
reporting_termbodystringNo
sale_itemsbodyList<FinanceCreateSaleItemsRequest>No
FinanceCreateSaleItemsRequest Parameters:
NameParameterData TypeRequiredDescription
amountformdecimalNo
codeformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Dynamics/CreateSale/{regent_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"regent_id":0,"amount":0,"code":"String","rebate_code":"String","rebate_amount":0,"payment_id":"String","reporting_term":"String","sale_items":[{"amount":0,"code":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}