POST Payments/Payment/RecalculateClientsInstallmentsAmounts

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientID	integer	None.
OverriddenInstallments	Collection of DirectDebitPaymentPlanInstallmentDTO	None.
IsEditMode	boolean	None.
DirectDebitPaymentDTO	DirectDebitPaymentDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "clientID": 1,
  "overriddenInstallments": [
    {
      "paymentPlanID": 1,
      "paymentItemID": 2,
      "paymentInstallmentID": 3,
      "selected": true,
      "firstName": "sample string 5",
      "lastName": "sample string 6",
      "residentNumber": "sample string 7",
      "businessUnit": "sample string 8",
      "installmentDate": "2024-12-04T07:48:14.7946808+00:00",
      "amount": 10.0,
      "outstandingAmount": 11.0,
      "buid": 12,
      "clientID": 13
    },
    {
      "paymentPlanID": 1,
      "paymentItemID": 2,
      "paymentInstallmentID": 3,
      "selected": true,
      "firstName": "sample string 5",
      "lastName": "sample string 6",
      "residentNumber": "sample string 7",
      "businessUnit": "sample string 8",
      "installmentDate": "2024-12-04T07:48:14.7946808+00:00",
      "amount": 10.0,
      "outstandingAmount": 11.0,
      "buid": 12,
      "clientID": 13
    }
  ],
  "isEditMode": true,
  "directDebitPaymentDTO": {
    "residentTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "funderIDs": [
      1,
      2
    ],
    "adHocInvoices": [
      1,
      2
    ],
    "directDebitInvoices": [
      1,
      2
    ],
    "selectedInstallments": [
      {
        "paymentPlanID": 1,
        "paymentItemID": 2,
        "paymentInstallmentID": 3,
        "selected": true,
        "firstName": "sample string 5",
        "lastName": "sample string 6",
        "residentNumber": "sample string 7",
        "businessUnit": "sample string 8",
        "installmentDate": "2024-12-04T07:48:14.7946808+00:00",
        "amount": 10.0,
        "outstandingAmount": 11.0,
        "buid": 12,
        "clientID": 13
      },
      {
        "paymentPlanID": 1,
        "paymentItemID": 2,
        "paymentInstallmentID": 3,
        "selected": true,
        "firstName": "sample string 5",
        "lastName": "sample string 6",
        "residentNumber": "sample string 7",
        "businessUnit": "sample string 8",
        "installmentDate": "2024-12-04T07:48:14.7946808+00:00",
        "amount": 10.0,
        "outstandingAmount": 11.0,
        "buid": 12,
        "clientID": 13
      }
    ],
    "businessUnitStatusTypes": [
      1,
      2
    ],
    "selectedBusinessUnits": [
      1,
      2
    ],
    "paymentID": 1,
    "journalIDs": [
      1,
      2
    ],
    "paymentBusinessUnits": [
      {
        "paymentID": 1,
        "buid": 2,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:48:14.8116361+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:48:14 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:48:14.8116361+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:48:14 AM"
        }
      },
      {
        "paymentID": 1,
        "buid": 2,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:48:14.8116361+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:48:14 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:48:14.8116361+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:48:14 AM"
        }
      }
    ],
    "businessUnitNames": "sample string 2",
    "paymentMethod": 10,
    "status": 1,
    "description": "sample string 3",
    "endDate": "2024-12-04T07:48:14.8116361+00:00",
    "paymentPlanEndDate": "2024-12-04T07:48:14.8116361+00:00",
    "totalAmount": 1.0,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:48:14.8116361+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:48:14 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:48:14.8116361+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:48:14 AM"
    },
    "postingDate": "2024-12-04T07:48:14.8116361+00:00"
  }
}

application/xml, text/xml

Sample:

<EditPaymentPlanInstallmentsAmountDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Billings.Models">
  <ClientID>1</ClientID>
  <DirectDebitPaymentDTO>
    <BusinessUnitNames>sample string 2</BusinessUnitNames>
    <Created xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
      <d3p1:DateUtc>2024-12-04T07:48:14.8116361+00:00</d3p1:DateUtc>
      <d3p1:UserName>sample string 2</d3p1:UserName>
    </Created>
    <Description>sample string 3</Description>
    <EndDate>2024-12-04T07:48:14.8116361+00:00</EndDate>
    <JournalIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </JournalIDs>
    <LastUpdated xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
      <d3p1:DateUtc>2024-12-04T07:48:14.8116361+00:00</d3p1:DateUtc>
      <d3p1:UserName>sample string 2</d3p1:UserName>
    </LastUpdated>
    <PaymentBusinessUnits>
      <PaymentBusinessUnitDTO>
        <BUID>2</BUID>
        <Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
          <d5p1:DateUtc>2024-12-04T07:48:14.8116361+00:00</d5p1:DateUtc>
          <d5p1:UserName>sample string 2</d5p1:UserName>
        </Created>
        <LastUpdated xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
          <d5p1:DateUtc>2024-12-04T07:48:14.8116361+00:00</d5p1:DateUtc>
          <d5p1:UserName>sample string 2</d5p1:UserName>
        </LastUpdated>
        <PaymentID>1</PaymentID>
        <RecordState>Active</RecordState>
      </PaymentBusinessUnitDTO>
      <PaymentBusinessUnitDTO>
        <BUID>2</BUID>
        <Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
          <d5p1:DateUtc>2024-12-04T07:48:14.8116361+00:00</d5p1:DateUtc>
          <d5p1:UserName>sample string 2</d5p1:UserName>
        </Created>
        <LastUpdated xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
          <d5p1:DateUtc>2024-12-04T07:48:14.8116361+00:00</d5p1:DateUtc>
          <d5p1:UserName>sample string 2</d5p1:UserName>
        </LastUpdated>
        <PaymentID>1</PaymentID>
        <RecordState>Active</RecordState>
      </PaymentBusinessUnitDTO>
    </PaymentBusinessUnits>
    <PaymentID>1</PaymentID>
    <PaymentItems i:nil="true" />
    <PaymentMethod>Cash</PaymentMethod>
    <PaymentPlanEndDate>2024-12-04T07:48:14.8116361+00:00</PaymentPlanEndDate>
    <PostingDate>2024-12-04T07:48:14.8116361+00:00</PostingDate>
    <RecordState>Active</RecordState>
    <Status>Draft</Status>
    <TotalAmount>1</TotalAmount>
    <AdHocInvoices xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </AdHocInvoices>
    <BusinessUnitStatusTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </BusinessUnitStatusTypes>
    <DirectDebitInvoices xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DirectDebitInvoices>
    <FunderIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </FunderIDs>
    <ResidentTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ResidentTypes>
    <SelectedBusinessUnits xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </SelectedBusinessUnits>
    <SelectedInstallments>
      <DirectDebitPaymentPlanInstallmentDTO>
        <Amount>10</Amount>
        <BUID>12</BUID>
        <BusinessUnit>sample string 8</BusinessUnit>
        <ClientID>13</ClientID>
        <FirstName>sample string 5</FirstName>
        <InstallmentDate>2024-12-04T07:48:14.7946808+00:00</InstallmentDate>
        <LastName>sample string 6</LastName>
        <OutstandingAmount>11</OutstandingAmount>
        <PaymentInstallmentID>3</PaymentInstallmentID>
        <PaymentItemID>2</PaymentItemID>
        <PaymentPlanID>1</PaymentPlanID>
        <ResidentNumber>sample string 7</ResidentNumber>
        <Selected>true</Selected>
      </DirectDebitPaymentPlanInstallmentDTO>
      <DirectDebitPaymentPlanInstallmentDTO>
        <Amount>10</Amount>
        <BUID>12</BUID>
        <BusinessUnit>sample string 8</BusinessUnit>
        <ClientID>13</ClientID>
        <FirstName>sample string 5</FirstName>
        <InstallmentDate>2024-12-04T07:48:14.7946808+00:00</InstallmentDate>
        <LastName>sample string 6</LastName>
        <OutstandingAmount>11</OutstandingAmount>
        <PaymentInstallmentID>3</PaymentInstallmentID>
        <PaymentItemID>2</PaymentItemID>
        <PaymentPlanID>1</PaymentPlanID>
        <ResidentNumber>sample string 7</ResidentNumber>
        <Selected>true</Selected>
      </DirectDebitPaymentPlanInstallmentDTO>
    </SelectedInstallments>
  </DirectDebitPaymentDTO>
  <IsEditMode>true</IsEditMode>
  <OverriddenInstallments>
    <DirectDebitPaymentPlanInstallmentDTO>
      <Amount>10</Amount>
      <BUID>12</BUID>
      <BusinessUnit>sample string 8</BusinessUnit>
      <ClientID>13</ClientID>
      <FirstName>sample string 5</FirstName>
      <InstallmentDate>2024-12-04T07:48:14.7946808+00:00</InstallmentDate>
      <LastName>sample string 6</LastName>
      <OutstandingAmount>11</OutstandingAmount>
      <PaymentInstallmentID>3</PaymentInstallmentID>
      <PaymentItemID>2</PaymentItemID>
      <PaymentPlanID>1</PaymentPlanID>
      <ResidentNumber>sample string 7</ResidentNumber>
      <Selected>true</Selected>
    </DirectDebitPaymentPlanInstallmentDTO>
    <DirectDebitPaymentPlanInstallmentDTO>
      <Amount>10</Amount>
      <BUID>12</BUID>
      <BusinessUnit>sample string 8</BusinessUnit>
      <ClientID>13</ClientID>
      <FirstName>sample string 5</FirstName>
      <InstallmentDate>2024-12-04T07:48:14.7946808+00:00</InstallmentDate>
      <LastName>sample string 6</LastName>
      <OutstandingAmount>11</OutstandingAmount>
      <PaymentInstallmentID>3</PaymentInstallmentID>
      <PaymentItemID>2</PaymentItemID>
      <PaymentPlanID>1</PaymentPlanID>
      <ResidentNumber>sample string 7</ResidentNumber>
      <Selected>true</Selected>
    </DirectDebitPaymentPlanInstallmentDTO>
  </OverriddenInstallments>
</EditPaymentPlanInstallmentsAmountDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

�픿n�0�_E�Z%e�v��P�jp��d��K�B"�	`~�}��B��d�RR����}�����}�����i�4$�	���̥��,+�I﷤f��d�In"���G�.��za%8I�v�G���e��V�%�j!��IHJ��8EQ�8��u��(e�)kg�cVR�Q�D7`Ƭ?'����Q��fi2Oir9��L���]�Q�U�RNbC]F��Yl"9��nꅵxO�8zh'���>���PZ\h��Zػ�l�����-���
.Aq��HL�G'9�<�4�1��'U��I��h�ؑ�>��Cg�5��s}��:�Z�t}?��:��{��]9-Y��K�0��*�Şd�4���^(4��m	�+[�fN�t2�G0΀~��bouWULo�Z�d@���4����6`U�1No����`�}o�l���7�m��2{���r0��J��'X
�����[�>i7Uh~>����?/�kǩ����jڻ�o�9M�.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, application/x-compressed-json

Sample:

Sample not available.