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 .xml suffix or ?format=xml

HTTP + 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>