AbodeONE

<back to all web services

PostBillingRegisterToExternal

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/post_billing_register
PostBillingRegisterToExternal Parameters:
NameParameterData TypeRequiredDescription
TermIdqueryintNo
FilenamequerystringNo
IsPreviewqueryboolNo
BillingRegistersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<BillingRegisterDTO>No
ResponseStatusformResponseStatusNo
BillingRegisterDTO Parameters:
NameParameterData TypeRequiredDescription
BillingIdformintNo
TermIdformint?No
StudentIdformintNo
ResidentIdformint?No
BuildingIdformint?No
DisciplineIdformint?No
BillingRentIdformint?No
ChargeDtformDateTimeNo
AmountformdecimalNo
DescriptionformstringNo
ChargeTypeformstringNo
PostBatchIdformint?No
PostDtformDateTime?No
AccountRefformstringNo
RefundableformboolNo
RefundedformboolNo
LockedformboolNo
RelatedRowformint?No
CreatedDtformDateTime?No
CreatedByformstringNo
LastModifiedDtformDateTime?No
LastModifiedByformstringNo
BuildingNameformstringNo
TotalBilledformdecimal?No

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 /post_billing_register HTTP/1.1 
Host: api.oau.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostBillingRegisterToExternal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <Filename>String</Filename>
  <IsPreview>false</IsPreview>
  <TermId>0</TermId>
</PostBillingRegisterToExternal>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BillingRegistersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <BillingRegisterDTO>
      <AccountRef>String</AccountRef>
      <Amount>0</Amount>
      <BillingId>0</BillingId>
      <BillingRentId>0</BillingRentId>
      <BuildingId>0</BuildingId>
      <BuildingName>String</BuildingName>
      <ChargeDt>0001-01-01T00:00:00</ChargeDt>
      <ChargeType>String</ChargeType>
      <CreatedBy>String</CreatedBy>
      <CreatedDt>0001-01-01T00:00:00</CreatedDt>
      <Description>String</Description>
      <DisciplineId>0</DisciplineId>
      <LastModifiedBy>String</LastModifiedBy>
      <LastModifiedDt>0001-01-01T00:00:00</LastModifiedDt>
      <Locked>false</Locked>
      <PostBatchId>0</PostBatchId>
      <PostDt>0001-01-01T00:00:00</PostDt>
      <Refundable>false</Refundable>
      <Refunded>false</Refunded>
      <RelatedRow>0</RelatedRow>
      <ResidentId>0</ResidentId>
      <StudentId>0</StudentId>
      <TermId>0</TermId>
      <TotalBilled>0</TotalBilled>
    </BillingRegisterDTO>
  </Result>
</BillingRegistersResponse>