POST api/arreceipts/nsffile

NSF Reversal via NSF files

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
FullFileName	Required. String containing both file location and file name with the extension. There must be two slashes for folder directories to bypass the escape characters. Example: C:\\Camacct_Content\\camacct_nyc\\RecurringTransaction\\recurring_charges_import.csv	string	Required

Request Formats

application/json, text/json

Sample:

{
  "fullFileName": "sample string 1"
}

application/xml, text/xml

Sample:

<ARReceiptNSFFileViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <FullFileName>sample string 1</FullFileName>
</ARReceiptNSFFileViewModel>

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

Response Information

Resource Description

NSFFileReversalResultViewModel

Name	Description	Type	Additional information
SuccessfulLineNumbers	Line Number of succesfully reversed line items	Collection of integer	None.
FailedLineNumbers	Line Number of failed reversed line items	Collection of integer	None.
ReversedReceipts	Creation of reversed ar receipts in the same order as successful line numbers	Collection of ARReceiptViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "successfulLineNumbers": [
    1,
    2
  ],
  "failedLineNumbers": [
    1,
    2
  ],
  "reversedReceipts": [
    {
      "receiptId": 1,
      "unitId": 1,
      "residentId": 1,
      "paymentType": "sample string 2",
      "checkNumber": "sample string 3",
      "receiptDate": "2024-10-14T08:25:21.314593-04:00",
      "receiptDescriptions": "sample string 4",
      "receiptType": 5,
      "arBatchReceiptId": 1,
      "auxillaryField": 1,
      "arReceiptTypeId": 6,
      "buildingId": 1,
      "createdDate": "2024-10-14T08:25:21.314593-04:00",
      "postDate": "2024-10-14T08:25:21.314593-04:00",
      "posted": 7,
      "transfered": 8,
      "reversed": true,
      "receiptAmount": 10.0,
      "receiptLineItems": [
        {
          "receiptLineItemId": 1,
          "receiptId": 2,
          "paymentAmount": 3.0,
          "chartOfAccountsId": 1,
          "glSubAccountId": 1,
          "prepayChargeCodeId": 1,
          "chargeId": 1,
          "creditId": 1,
          "securityDepositTypeId": 4,
          "originalAmount": 5.0,
          "refundAmount": 6.0,
          "refunded": true,
          "dateRefunded": "2024-10-14T08:25:21.314593-04:00",
          "securityDepositType": {
            "id": 1,
            "description": "sample string 2",
            "depositCode": "sample string 3",
            "depositGLAccountId": 4,
            "depositGLSubAccountId": 5,
            "refundGLAccountId": 6,
            "refundGLSubAccount": 7,
            "interestRate": 8.0,
            "isActive": true
          }
        },
        {
          "receiptLineItemId": 1,
          "receiptId": 2,
          "paymentAmount": 3.0,
          "chartOfAccountsId": 1,
          "glSubAccountId": 1,
          "prepayChargeCodeId": 1,
          "chargeId": 1,
          "creditId": 1,
          "securityDepositTypeId": 4,
          "originalAmount": 5.0,
          "refundAmount": 6.0,
          "refunded": true,
          "dateRefunded": "2024-10-14T08:25:21.314593-04:00",
          "securityDepositType": {
            "id": 1,
            "description": "sample string 2",
            "depositCode": "sample string 3",
            "depositGLAccountId": 4,
            "depositGLSubAccountId": 5,
            "refundGLAccountId": 6,
            "refundGLSubAccount": 7,
            "interestRate": 8.0,
            "isActive": true
          }
        }
      ],
      "bankCode": "sample string 11",
      "isBankCodeActive": true
    },
    {
      "receiptId": 1,
      "unitId": 1,
      "residentId": 1,
      "paymentType": "sample string 2",
      "checkNumber": "sample string 3",
      "receiptDate": "2024-10-14T08:25:21.314593-04:00",
      "receiptDescriptions": "sample string 4",
      "receiptType": 5,
      "arBatchReceiptId": 1,
      "auxillaryField": 1,
      "arReceiptTypeId": 6,
      "buildingId": 1,
      "createdDate": "2024-10-14T08:25:21.314593-04:00",
      "postDate": "2024-10-14T08:25:21.314593-04:00",
      "posted": 7,
      "transfered": 8,
      "reversed": true,
      "receiptAmount": 10.0,
      "receiptLineItems": [
        {
          "receiptLineItemId": 1,
          "receiptId": 2,
          "paymentAmount": 3.0,
          "chartOfAccountsId": 1,
          "glSubAccountId": 1,
          "prepayChargeCodeId": 1,
          "chargeId": 1,
          "creditId": 1,
          "securityDepositTypeId": 4,
          "originalAmount": 5.0,
          "refundAmount": 6.0,
          "refunded": true,
          "dateRefunded": "2024-10-14T08:25:21.314593-04:00",
          "securityDepositType": {
            "id": 1,
            "description": "sample string 2",
            "depositCode": "sample string 3",
            "depositGLAccountId": 4,
            "depositGLSubAccountId": 5,
            "refundGLAccountId": 6,
            "refundGLSubAccount": 7,
            "interestRate": 8.0,
            "isActive": true
          }
        },
        {
          "receiptLineItemId": 1,
          "receiptId": 2,
          "paymentAmount": 3.0,
          "chartOfAccountsId": 1,
          "glSubAccountId": 1,
          "prepayChargeCodeId": 1,
          "chargeId": 1,
          "creditId": 1,
          "securityDepositTypeId": 4,
          "originalAmount": 5.0,
          "refundAmount": 6.0,
          "refunded": true,
          "dateRefunded": "2024-10-14T08:25:21.314593-04:00",
          "securityDepositType": {
            "id": 1,
            "description": "sample string 2",
            "depositCode": "sample string 3",
            "depositGLAccountId": 4,
            "depositGLSubAccountId": 5,
            "refundGLAccountId": 6,
            "refundGLSubAccount": 7,
            "interestRate": 8.0,
            "isActive": true
          }
        }
      ],
      "bankCode": "sample string 11",
      "isBankCodeActive": true
    }
  ]
}

application/xml, text/xml

Sample:

<NSFFileReversalResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <FailedLineNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FailedLineNumbers>
  <ReversedReceipts>
    <ARReceiptViewModel>
      <ArBatchReceiptId>1</ArBatchReceiptId>
      <ArReceiptTypeId>6</ArReceiptTypeId>
      <AuxillaryField>1</AuxillaryField>
      <BankCode>sample string 11</BankCode>
      <BuildingId>1</BuildingId>
      <CheckNumber>sample string 3</CheckNumber>
      <CreatedDate>2024-10-14T08:25:21.314593-04:00</CreatedDate>
      <IsBankCodeActive>true</IsBankCodeActive>
      <PaymentType>sample string 2</PaymentType>
      <PostDate>2024-10-14T08:25:21.314593-04:00</PostDate>
      <Posted>7</Posted>
      <ReceiptAmount>10</ReceiptAmount>
      <ReceiptDate>2024-10-14T08:25:21.314593-04:00</ReceiptDate>
      <ReceiptDescriptions>sample string 4</ReceiptDescriptions>
      <ReceiptId>1</ReceiptId>
      <ReceiptLineItems>
        <ReceiptLineItemViewModel>
          <ChargeId>1</ChargeId>
          <ChartOfAccountsId>1</ChartOfAccountsId>
          <CreditId>1</CreditId>
          <DateRefunded>2024-10-14T08:25:21.314593-04:00</DateRefunded>
          <GlSubAccountId>1</GlSubAccountId>
          <OriginalAmount>5</OriginalAmount>
          <PaymentAmount>3</PaymentAmount>
          <PrepayChargeCodeId>1</PrepayChargeCodeId>
          <ReceiptId>2</ReceiptId>
          <ReceiptLineItemId>1</ReceiptLineItemId>
          <RefundAmount>6</RefundAmount>
          <Refunded>true</Refunded>
          <SecurityDepositType>
            <DepositCode>sample string 3</DepositCode>
            <DepositGLAccountId>4</DepositGLAccountId>
            <DepositGLSubAccountId>5</DepositGLSubAccountId>
            <Description>sample string 2</Description>
            <Id>1</Id>
            <InterestRate>8</InterestRate>
            <IsActive>true</IsActive>
            <RefundGLAccountId>6</RefundGLAccountId>
            <RefundGLSubAccount>7</RefundGLSubAccount>
          </SecurityDepositType>
          <SecurityDepositTypeId>4</SecurityDepositTypeId>
        </ReceiptLineItemViewModel>
        <ReceiptLineItemViewModel>
          <ChargeId>1</ChargeId>
          <ChartOfAccountsId>1</ChartOfAccountsId>
          <CreditId>1</CreditId>
          <DateRefunded>2024-10-14T08:25:21.314593-04:00</DateRefunded>
          <GlSubAccountId>1</GlSubAccountId>
          <OriginalAmount>5</OriginalAmount>
          <PaymentAmount>3</PaymentAmount>
          <PrepayChargeCodeId>1</PrepayChargeCodeId>
          <ReceiptId>2</ReceiptId>
          <ReceiptLineItemId>1</ReceiptLineItemId>
          <RefundAmount>6</RefundAmount>
          <Refunded>true</Refunded>
          <SecurityDepositType>
            <DepositCode>sample string 3</DepositCode>
            <DepositGLAccountId>4</DepositGLAccountId>
            <DepositGLSubAccountId>5</DepositGLSubAccountId>
            <Description>sample string 2</Description>
            <Id>1</Id>
            <InterestRate>8</InterestRate>
            <IsActive>true</IsActive>
            <RefundGLAccountId>6</RefundGLAccountId>
            <RefundGLSubAccount>7</RefundGLSubAccount>
          </SecurityDepositType>
          <SecurityDepositTypeId>4</SecurityDepositTypeId>
        </ReceiptLineItemViewModel>
      </ReceiptLineItems>
      <ReceiptType>5</ReceiptType>
      <ResidentId>1</ResidentId>
      <Reversed>true</Reversed>
      <Transfered>8</Transfered>
      <UnitId>1</UnitId>
    </ARReceiptViewModel>
    <ARReceiptViewModel>
      <ArBatchReceiptId>1</ArBatchReceiptId>
      <ArReceiptTypeId>6</ArReceiptTypeId>
      <AuxillaryField>1</AuxillaryField>
      <BankCode>sample string 11</BankCode>
      <BuildingId>1</BuildingId>
      <CheckNumber>sample string 3</CheckNumber>
      <CreatedDate>2024-10-14T08:25:21.314593-04:00</CreatedDate>
      <IsBankCodeActive>true</IsBankCodeActive>
      <PaymentType>sample string 2</PaymentType>
      <PostDate>2024-10-14T08:25:21.314593-04:00</PostDate>
      <Posted>7</Posted>
      <ReceiptAmount>10</ReceiptAmount>
      <ReceiptDate>2024-10-14T08:25:21.314593-04:00</ReceiptDate>
      <ReceiptDescriptions>sample string 4</ReceiptDescriptions>
      <ReceiptId>1</ReceiptId>
      <ReceiptLineItems>
        <ReceiptLineItemViewModel>
          <ChargeId>1</ChargeId>
          <ChartOfAccountsId>1</ChartOfAccountsId>
          <CreditId>1</CreditId>
          <DateRefunded>2024-10-14T08:25:21.314593-04:00</DateRefunded>
          <GlSubAccountId>1</GlSubAccountId>
          <OriginalAmount>5</OriginalAmount>
          <PaymentAmount>3</PaymentAmount>
          <PrepayChargeCodeId>1</PrepayChargeCodeId>
          <ReceiptId>2</ReceiptId>
          <ReceiptLineItemId>1</ReceiptLineItemId>
          <RefundAmount>6</RefundAmount>
          <Refunded>true</Refunded>
          <SecurityDepositType>
            <DepositCode>sample string 3</DepositCode>
            <DepositGLAccountId>4</DepositGLAccountId>
            <DepositGLSubAccountId>5</DepositGLSubAccountId>
            <Description>sample string 2</Description>
            <Id>1</Id>
            <InterestRate>8</InterestRate>
            <IsActive>true</IsActive>
            <RefundGLAccountId>6</RefundGLAccountId>
            <RefundGLSubAccount>7</RefundGLSubAccount>
          </SecurityDepositType>
          <SecurityDepositTypeId>4</SecurityDepositTypeId>
        </ReceiptLineItemViewModel>
        <ReceiptLineItemViewModel>
          <ChargeId>1</ChargeId>
          <ChartOfAccountsId>1</ChartOfAccountsId>
          <CreditId>1</CreditId>
          <DateRefunded>2024-10-14T08:25:21.314593-04:00</DateRefunded>
          <GlSubAccountId>1</GlSubAccountId>
          <OriginalAmount>5</OriginalAmount>
          <PaymentAmount>3</PaymentAmount>
          <PrepayChargeCodeId>1</PrepayChargeCodeId>
          <ReceiptId>2</ReceiptId>
          <ReceiptLineItemId>1</ReceiptLineItemId>
          <RefundAmount>6</RefundAmount>
          <Refunded>true</Refunded>
          <SecurityDepositType>
            <DepositCode>sample string 3</DepositCode>
            <DepositGLAccountId>4</DepositGLAccountId>
            <DepositGLSubAccountId>5</DepositGLSubAccountId>
            <Description>sample string 2</Description>
            <Id>1</Id>
            <InterestRate>8</InterestRate>
            <IsActive>true</IsActive>
            <RefundGLAccountId>6</RefundGLAccountId>
            <RefundGLSubAccount>7</RefundGLSubAccount>
          </SecurityDepositType>
          <SecurityDepositTypeId>4</SecurityDepositTypeId>
        </ReceiptLineItemViewModel>
      </ReceiptLineItems>
      <ReceiptType>5</ReceiptType>
      <ResidentId>1</ResidentId>
      <Reversed>true</Reversed>
      <Transfered>8</Transfered>
      <UnitId>1</UnitId>
    </ARReceiptViewModel>
  </ReversedReceipts>
  <SuccessfulLineNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SuccessfulLineNumbers>
</NSFFileReversalResultViewModel>