POST api/debitmemo/voidDebitMemoBatch

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DebitMemoId	Debit Memo Id	integer	None.
UserId	User Id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "debitMemoId": 1,
  "userId": 2
}

application/xml, text/xml

Sample:

<VoidDebitMemoParametersViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <DebitMemoId>1</DebitMemoId>
  <UserId>2</UserId>
</VoidDebitMemoParametersViewModel>

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 'VoidDebitMemoParametersViewModel'.

Response Information

Resource Description

DebitMemoBatchViewModel

Name	Description	Type	Additional information
DebitMemoBatchId	Debit Memo Batch ID	integer	None.
PaymentAmount	Payment Amount	decimal number	None.
PaymentTypeId	Payment Type ID	integer	None.
PaymentType	Payment Type	PaymentTypeViewModel	None.
ReferenceNumber	Reference Number	string	None.
PaymentDate	Payment Date	date	None.
StatusId	Status Id	integer	None.
Status	Status	BatchStatusViewModel	None.
BankReconciliationId	Bank Reconcilation Id	integer	None.
BankReconciliation	Bank Reconciliation	BankReconciliationViewModel	None.
ReconciledOn	Reconciled On	date	None.
VendorId	Vendor Id	integer	None.
Vendor	Vendor	VendorViewModel	None.
BankCodeId	Bank Code Id	integer	None.
BankCode	Bank Code	BankCodeDetailsViewModel	None.
CreatedBy	Created By	integer	None.
CreatedOn	Created On	date	None.
MemoInvoiceLinks	Memo Invoice Links	Collection of DebitMemoInvoiceLinkViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "debitMemoBatchId": 1,
  "paymentAmount": 2.0,
  "paymentTypeId": 3,
  "paymentType": {
    "paymentTypeId": 1,
    "paymentTypeName": "sample string 2"
  },
  "referenceNumber": "sample string 4",
  "paymentDate": "2024-10-14T08:23:34.5622169-04:00",
  "statusId": 6,
  "status": {
    "batchStatusId": 1,
    "batchStatusName": "sample string 2"
  },
  "bankReconciliationId": 1,
  "bankReconciliation": {
    "id": 1,
    "bankCodeId": 2,
    "dateReconciled": "2024-10-14T08:23:34.5622169-04:00",
    "bankStatementBalance": 4.0,
    "bookBalance": 5.0,
    "statementDate": "2024-10-14T08:23:34.5622169-04:00",
    "completed": true,
    "fileName": "sample string 8",
    "entityId": 9
  },
  "reconciledOn": "2024-10-14T08:23:34.5622169-04:00",
  "vendorId": 7,
  "vendor": {
    "id": 1,
    "name": "sample string 2",
    "phone": "sample string 3",
    "faxNumber": "sample string 4",
    "contact": "sample string 5",
    "email": "sample string 6",
    "legalName": "sample string 7",
    "isActive": true,
    "vendorCode": "sample string 9",
    "isSeparateChecks": true,
    "isAllowDuplicateInvoices": true,
    "typeDescription": "sample string 12",
    "vendorServiceId": 1,
    "is1099": true,
    "hasMetersAssigned": true,
    "vendorTypeId": 15,
    "address": {
      "addressId": 1,
      "address1": "sample string 2",
      "address2": "sample string 3",
      "city": "sample string 4",
      "state": "sample string 5",
      "zipCode": "sample string 6",
      "country": "sample string 7"
    },
    "physicalAddress": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zipCode": "sample string 5",
      "country": "sample string 6"
    },
    "physicalAddressSameAsMailingAddress": true
  },
  "bankCodeId": 8,
  "bankCode": {
    "bankCodeId": 1,
    "bankId": 1,
    "superEntityId": 2,
    "chartOfAccountsId": 3,
    "interestChartOfAccountID": 1,
    "interestGlSubAccountID": 1,
    "bankFeeChartOfAccountID": 1,
    "bankFeeGlSubAccountID": 1,
    "code": "sample string 4",
    "bankCodeDescription": "sample string 5",
    "glAccountId": 6,
    "glAccountNumber": "sample string 7",
    "glAccountDescription": "sample string 8",
    "glSubAccountName": "sample string 9",
    "achCode": "sample string 10",
    "abaNumber": "sample string 11",
    "abaNumberId": 1,
    "bankAccount": "sample string 12",
    "brokerageAccount": "sample string 13",
    "mcirDescription1": "sample string 14",
    "mcirDescription2": "sample string 15",
    "checkPrintDescription1": "sample string 16",
    "checkPrintDescription2": "sample string 17",
    "checkPrintDescription3": "sample string 18",
    "micr1": "sample string 19",
    "micr2": "sample string 20",
    "lastCheckNumber": 21,
    "addressId": 22,
    "address1": "sample string 23",
    "address2": "sample string 24",
    "city": "sample string 25",
    "state": "sample string 26",
    "country": "sample string 27",
    "zipCode": "sample string 28",
    "isActive": true,
    "isTransactionalBank": true,
    "nonTransactionalAccount": true,
    "isCheckExport": true,
    "accountTypeId": 1,
    "accountUseId": 1,
    "positivePayEligible": true,
    "bankBalanceMinimum": 32,
    "glSubAccountId": 33,
    "autoSignMaxAmount": 1.0,
    "interestBearingAccount": {
      "term": 1,
      "id": 1,
      "accountTypeId": 2,
      "effectiveRate": 1.0,
      "effectiveDate": "2024-10-14T08:23:34.5622169-04:00",
      "maturityDate": "2024-10-14T08:23:34.5622169-04:00"
    },
    "checkSignatureId": 1
  },
  "createdBy": 9,
  "createdOn": "2024-10-14T08:23:34.5622169-04:00",
  "memoInvoiceLinks": [
    {
      "linkId": 1,
      "debitMemoBatchId": 2,
      "invoiceId": 3,
      "appliedAmount": 4.0
    },
    {
      "linkId": 1,
      "debitMemoBatchId": 2,
      "invoiceId": 3,
      "appliedAmount": 4.0
    }
  ]
}

application/xml, text/xml

Sample:

<DebitMemoBatchViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BankCode>
    <AbaNumber>sample string 11</AbaNumber>
    <AbaNumberId>1</AbaNumberId>
    <AccountTypeId>1</AccountTypeId>
    <AccountUseId>1</AccountUseId>
    <AchCode>sample string 10</AchCode>
    <Address1>sample string 23</Address1>
    <Address2>sample string 24</Address2>
    <AddressId>22</AddressId>
    <AutoSignMaxAmount>1</AutoSignMaxAmount>
    <BankAccount>sample string 12</BankAccount>
    <BankBalanceMinimum>32</BankBalanceMinimum>
    <BankCodeDescription>sample string 5</BankCodeDescription>
    <BankCodeId>1</BankCodeId>
    <BankFeeChartOfAccountID>1</BankFeeChartOfAccountID>
    <BankFeeGlSubAccountID>1</BankFeeGlSubAccountID>
    <BankId>1</BankId>
    <BrokerageAccount>sample string 13</BrokerageAccount>
    <ChartOfAccountsId>3</ChartOfAccountsId>
    <CheckPrintDescription1>sample string 16</CheckPrintDescription1>
    <CheckPrintDescription2>sample string 17</CheckPrintDescription2>
    <CheckPrintDescription3>sample string 18</CheckPrintDescription3>
    <CheckSignatureId>1</CheckSignatureId>
    <City>sample string 25</City>
    <Code>sample string 4</Code>
    <Country>sample string 27</Country>
    <GLAccountDescription>sample string 8</GLAccountDescription>
    <GLAccountId>6</GLAccountId>
    <GLAccountNumber>sample string 7</GLAccountNumber>
    <GLSubAccountId>33</GLSubAccountId>
    <GLSubAccountName>sample string 9</GLSubAccountName>
    <InterestBearingAccount xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.AccountType">
      <d3p1:AccountTypeId>2</d3p1:AccountTypeId>
      <d3p1:EffectiveDate>2024-10-14T08:23:34.5622169-04:00</d3p1:EffectiveDate>
      <d3p1:EffectiveRate>1</d3p1:EffectiveRate>
      <d3p1:MaturityDate>2024-10-14T08:23:34.5622169-04:00</d3p1:MaturityDate>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Term>1</d3p1:Term>
    </InterestBearingAccount>
    <InterestChartOfAccountID>1</InterestChartOfAccountID>
    <InterestGlSubAccountID>1</InterestGlSubAccountID>
    <IsActive>true</IsActive>
    <IsCheckExport>true</IsCheckExport>
    <IsTransactionalBank>true</IsTransactionalBank>
    <LastCheckNumber>21</LastCheckNumber>
    <McirDescription1>sample string 14</McirDescription1>
    <McirDescription2>sample string 15</McirDescription2>
    <Micr1>sample string 19</Micr1>
    <Micr2>sample string 20</Micr2>
    <NonTransactionalAccount>true</NonTransactionalAccount>
    <PositivePayEligible>true</PositivePayEligible>
    <State>sample string 26</State>
    <SuperEntityId>2</SuperEntityId>
    <ZipCode>sample string 28</ZipCode>
  </BankCode>
  <BankCodeId>8</BankCodeId>
  <BankReconciliation>
    <BankCodeId>2</BankCodeId>
    <BankStatementBalance>4</BankStatementBalance>
    <BookBalance>5</BookBalance>
    <Completed>true</Completed>
    <DateReconciled>2024-10-14T08:23:34.5622169-04:00</DateReconciled>
    <EntityId>9</EntityId>
    <FileName>sample string 8</FileName>
    <Id>1</Id>
    <StatementDate>2024-10-14T08:23:34.5622169-04:00</StatementDate>
  </BankReconciliation>
  <BankReconciliationId>1</BankReconciliationId>
  <CreatedBy>9</CreatedBy>
  <CreatedOn>2024-10-14T08:23:34.5622169-04:00</CreatedOn>
  <DebitMemoBatchId>1</DebitMemoBatchId>
  <MemoInvoiceLinks>
    <DebitMemoInvoiceLinkViewModel>
      <AppliedAmount>4</AppliedAmount>
      <DebitMemoBatchId>2</DebitMemoBatchId>
      <InvoiceId>3</InvoiceId>
      <LinkId>1</LinkId>
    </DebitMemoInvoiceLinkViewModel>
    <DebitMemoInvoiceLinkViewModel>
      <AppliedAmount>4</AppliedAmount>
      <DebitMemoBatchId>2</DebitMemoBatchId>
      <InvoiceId>3</InvoiceId>
      <LinkId>1</LinkId>
    </DebitMemoInvoiceLinkViewModel>
  </MemoInvoiceLinks>
  <PaymentAmount>2</PaymentAmount>
  <PaymentDate>2024-10-14T08:23:34.5622169-04:00</PaymentDate>
  <PaymentType>
    <PaymentTypeId>1</PaymentTypeId>
    <PaymentTypeName>sample string 2</PaymentTypeName>
  </PaymentType>
  <PaymentTypeId>3</PaymentTypeId>
  <ReconciledOn>2024-10-14T08:23:34.5622169-04:00</ReconciledOn>
  <ReferenceNumber>sample string 4</ReferenceNumber>
  <Status>
    <BatchStatusId>1</BatchStatusId>
    <BatchStatusName>sample string 2</BatchStatusName>
  </Status>
  <StatusId>6</StatusId>
  <Vendor>
    <Address>
      <Address1 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 2</Address1>
      <Address2 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 3</Address2>
      <City xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 4</City>
      <Country xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 7</Country>
      <State xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 5</State>
      <ZipCode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 6</ZipCode>
      <AddressId>1</AddressId>
    </Address>
    <Contact>sample string 5</Contact>
    <Email>sample string 6</Email>
    <FaxNumber>sample string 4</FaxNumber>
    <HasMetersAssigned>true</HasMetersAssigned>
    <Id>1</Id>
    <Is1099>true</Is1099>
    <IsActive>true</IsActive>
    <IsAllowDuplicateInvoices>true</IsAllowDuplicateInvoices>
    <IsSeparateChecks>true</IsSeparateChecks>
    <LegalName>sample string 7</LegalName>
    <Name>sample string 2</Name>
    <Phone>sample string 3</Phone>
    <PhysicalAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:ZipCode>sample string 5</d3p1:ZipCode>
    </PhysicalAddress>
    <PhysicalAddressSameAsMailingAddress>true</PhysicalAddressSameAsMailingAddress>
    <TypeDescription>sample string 12</TypeDescription>
    <VendorCode>sample string 9</VendorCode>
    <VendorServiceId>1</VendorServiceId>
    <VendorTypeId>15</VendorTypeId>
  </Vendor>
  <VendorId>7</VendorId>
</DebitMemoBatchViewModel>