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}
"use strict";
export class FinanceCreateSaleItemsRequest {
    /** @param {{amount?:number,code?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    amount;
    /** @type {string} */
    code;
}
export class FinanceCreateSaleRequest {
    /** @param {{regent_id?:number,amount?:number,code?:string,rebate_code?:string,rebate_amount?:number,payment_id?:string,reporting_term?:string,sale_items?:FinanceCreateSaleItemsRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {number} */
    amount;
    /** @type {string} */
    code;
    /** @type {string} */
    rebate_code;
    /** @type {?number} */
    rebate_amount;
    /** @type {string} */
    payment_id;
    /** @type {string} */
    reporting_term;
    /** @type {FinanceCreateSaleItemsRequest[]} */
    sale_items;
}

JavaScript FinanceCreateSaleRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

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