POST api/VendorEntity/StartBalance

Insert Vendor-Entity Beginning balances

Request Information

URI Parameters

None.

Body Parameters

A list containing all beginning balances

Collection of VendorEntityStartBalanceViewModel

Name	Description	Type	Additional information
StartBalanceId	Start Balance Id	integer	None.
VendorId	Vendor Id	integer	None.
EntityId	Entity Id	integer	None.
TaxYear	Tax Year	integer	None.
StartBalanceAmount	Start Balance Amount	decimal number	None.
CreatedOn	Created On	date	None.
CreatedBy	Created By	integer	None.
Errors	Error list generated by the validation process	Collection of string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "startBalanceId": 1,
    "vendorId": 2,
    "entityId": 3,
    "taxYear": 4,
    "startBalanceAmount": 5.0,
    "createdOn": "2024-10-14T08:18:49.8586373-04:00",
    "createdBy": 7,
    "errors": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "startBalanceId": 1,
    "vendorId": 2,
    "entityId": 3,
    "taxYear": 4,
    "startBalanceAmount": 5.0,
    "createdOn": "2024-10-14T08:18:49.8586373-04:00",
    "createdBy": 7,
    "errors": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfVendorEntityStartBalanceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <VendorEntityStartBalanceViewModel>
    <CreatedBy>7</CreatedBy>
    <CreatedOn>2024-10-14T08:18:49.8586373-04:00</CreatedOn>
    <EntityId>3</EntityId>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <StartBalanceAmount>5</StartBalanceAmount>
    <StartBalanceId>1</StartBalanceId>
    <TaxYear>4</TaxYear>
    <VendorId>2</VendorId>
  </VendorEntityStartBalanceViewModel>
  <VendorEntityStartBalanceViewModel>
    <CreatedBy>7</CreatedBy>
    <CreatedOn>2024-10-14T08:18:49.8586373-04:00</CreatedOn>
    <EntityId>3</EntityId>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <StartBalanceAmount>5</StartBalanceAmount>
    <StartBalanceId>1</StartBalanceId>
    <TaxYear>4</TaxYear>
    <VendorId>2</VendorId>
  </VendorEntityStartBalanceViewModel>
</ArrayOfVendorEntityStartBalanceViewModel>

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 'VendorEntityStartBalanceViewModel[]'.

Response Information

Resource Description

Collection of VendorEntityStartBalanceViewModel

Name	Description	Type	Additional information
StartBalanceId	Start Balance Id	integer	None.
VendorId	Vendor Id	integer	None.
EntityId	Entity Id	integer	None.
TaxYear	Tax Year	integer	None.
StartBalanceAmount	Start Balance Amount	decimal number	None.
CreatedOn	Created On	date	None.
CreatedBy	Created By	integer	None.
Errors	Error list generated by the validation process	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "startBalanceId": 1,
    "vendorId": 2,
    "entityId": 3,
    "taxYear": 4,
    "startBalanceAmount": 5.0,
    "createdOn": "2024-10-14T08:18:49.8586373-04:00",
    "createdBy": 7,
    "errors": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "startBalanceId": 1,
    "vendorId": 2,
    "entityId": 3,
    "taxYear": 4,
    "startBalanceAmount": 5.0,
    "createdOn": "2024-10-14T08:18:49.8586373-04:00",
    "createdBy": 7,
    "errors": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfVendorEntityStartBalanceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <VendorEntityStartBalanceViewModel>
    <CreatedBy>7</CreatedBy>
    <CreatedOn>2024-10-14T08:18:49.8586373-04:00</CreatedOn>
    <EntityId>3</EntityId>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <StartBalanceAmount>5</StartBalanceAmount>
    <StartBalanceId>1</StartBalanceId>
    <TaxYear>4</TaxYear>
    <VendorId>2</VendorId>
  </VendorEntityStartBalanceViewModel>
  <VendorEntityStartBalanceViewModel>
    <CreatedBy>7</CreatedBy>
    <CreatedOn>2024-10-14T08:18:49.8586373-04:00</CreatedOn>
    <EntityId>3</EntityId>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <StartBalanceAmount>5</StartBalanceAmount>
    <StartBalanceId>1</StartBalanceId>
    <TaxYear>4</TaxYear>
    <VendorId>2</VendorId>
  </VendorEntityStartBalanceViewModel>
</ArrayOfVendorEntityStartBalanceViewModel>