POST api/billingtransactionsbatch

Creates charges/credits from billing transaction records (billing transaction records comes from connect) List of transactions in view model can't be null or empty.

Request Information

URI Parameters

None.

Body Parameters

CreateBillingTransactionBatchViewModel

Name	Description	Type	Additional information
BillingTransactions		Collection of BillingTransactionInsertViewModel	None.
BatchDescription		string	Required

Request Formats

application/json, text/json

Sample:

{
  "billingTransactions": [
    {
      "billingTransactionId": 1,
      "entityNumber": "sample string 2",
      "readableBuildingId": "sample string 3",
      "unitNumber": "sample string 4",
      "readableResidentId": "sample string 5",
      "chargeCode": "sample string 6",
      "adjustedCode": "sample string 7",
      "description": "sample string 8",
      "date": "2024-10-13T16:18:28.6274405-04:00",
      "amount": 10.0,
      "transactionType": 1
    },
    {
      "billingTransactionId": 1,
      "entityNumber": "sample string 2",
      "readableBuildingId": "sample string 3",
      "unitNumber": "sample string 4",
      "readableResidentId": "sample string 5",
      "chargeCode": "sample string 6",
      "adjustedCode": "sample string 7",
      "description": "sample string 8",
      "date": "2024-10-13T16:18:28.6274405-04:00",
      "amount": 10.0,
      "transactionType": 1
    }
  ],
  "batchDescription": "sample string 1"
}

application/xml, text/xml

Sample:

<CreateBillingTransactionBatchViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.BillingTransaction">
  <BatchDescription>sample string 1</BatchDescription>
  <BillingTransactions>
    <BillingTransactionInsertViewModel>
      <AdjustedCode>sample string 7</AdjustedCode>
      <Amount>10</Amount>
      <BillingTransactionId>1</BillingTransactionId>
      <ChargeCode>sample string 6</ChargeCode>
      <Date>2024-10-13T16:18:28.6274405-04:00</Date>
      <Description>sample string 8</Description>
      <EntityNumber>sample string 2</EntityNumber>
      <ReadableBuildingId>sample string 3</ReadableBuildingId>
      <ReadableResidentId>sample string 5</ReadableResidentId>
      <TransactionType>Charge</TransactionType>
      <UnitNumber>sample string 4</UnitNumber>
    </BillingTransactionInsertViewModel>
    <BillingTransactionInsertViewModel>
      <AdjustedCode>sample string 7</AdjustedCode>
      <Amount>10</Amount>
      <BillingTransactionId>1</BillingTransactionId>
      <ChargeCode>sample string 6</ChargeCode>
      <Date>2024-10-13T16:18:28.6274405-04:00</Date>
      <Description>sample string 8</Description>
      <EntityNumber>sample string 2</EntityNumber>
      <ReadableBuildingId>sample string 3</ReadableBuildingId>
      <ReadableResidentId>sample string 5</ReadableResidentId>
      <TransactionType>Charge</TransactionType>
      <UnitNumber>sample string 4</UnitNumber>
    </BillingTransactionInsertViewModel>
  </BillingTransactions>
</CreateBillingTransactionBatchViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateBillingTransactionBatchViewModel'.

Response Information

Resource Description

List of BillingTransactionViewModel

BillingTransactionViewModel

Name	Type	Additional information
TransactionId	integer	None.
BatchId	integer	None.
Errors	Collection of string	None.
BillingTransactionId	integer	None.
EntityNumber	string	None.
ReadableBuildingId	string	None.
UnitNumber	string	None.
ReadableResidentId	string	None.
ChargeCode	string	None.
AdjustedCode	string	None.
Description	string	None.
Date	date	None.
Amount	decimal number	None.
TransactionType	BillingTransactionTypeEnum	None.

Response Formats

application/json, text/json

Sample:

{
  "transactionId": 1,
  "batchId": 1,
  "errors": [
    "sample string 1",
    "sample string 2"
  ],
  "billingTransactionId": 1,
  "entityNumber": "sample string 2",
  "readableBuildingId": "sample string 3",
  "unitNumber": "sample string 4",
  "readableResidentId": "sample string 5",
  "chargeCode": "sample string 6",
  "adjustedCode": "sample string 7",
  "description": "sample string 8",
  "date": "2024-10-13T16:18:28.6274405-04:00",
  "amount": 10.0,
  "transactionType": 1
}

application/xml, text/xml

Sample:

<BillingTransactionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.BillingTransaction">
  <AdjustedCode>sample string 7</AdjustedCode>
  <Amount>10</Amount>
  <BillingTransactionId>1</BillingTransactionId>
  <ChargeCode>sample string 6</ChargeCode>
  <Date>2024-10-13T16:18:28.6274405-04:00</Date>
  <Description>sample string 8</Description>
  <EntityNumber>sample string 2</EntityNumber>
  <ReadableBuildingId>sample string 3</ReadableBuildingId>
  <ReadableResidentId>sample string 5</ReadableResidentId>
  <TransactionType>Charge</TransactionType>
  <UnitNumber>sample string 4</UnitNumber>
  <BatchId>1</BatchId>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <TransactionId>1</TransactionId>
</BillingTransactionViewModel>