Required permission: | CreatePayments |
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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FinanceCreateSaleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<amount>0</amount>
<code>String</code>
<payment_id>String</payment_id>
<rebate_amount>0</rebate_amount>
<rebate_code>String</rebate_code>
<regent_id>0</regent_id>
<reporting_term>String</reporting_term>
<sale_items>
<FinanceCreateSaleItemsRequest>
<amount>0</amount>
<code>String</code>
</FinanceCreateSaleItemsRequest>
</sale_items>
</FinanceCreateSaleRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>String</d4p1:Key> <d4p1:Value>String</d4p1:Value> </d4p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> </ResponseStatus>