POST Payments/Payment/PaymentPlanInstallments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ResidentTypes	Collection of string	None.
FunderIDs	Collection of integer	None.
AdHocInvoices	Collection of integer	None.
DirectDebitInvoices	Collection of integer	None.
SelectedInstallments	Collection of DirectDebitPaymentPlanInstallmentDTO	None.
BusinessUnitStatusTypes	Collection of integer	None.
SelectedBusinessUnits	Collection of integer	None.
PaymentID	integer	None.
JournalIDs	Collection of integer	None.
PaymentItems	Collection of PaymentItemDTO	None.
PaymentBusinessUnits	Collection of PaymentBusinessUnitDTO	None.
BusinessUnitNames	string	None.
PaymentMethod	PaymentMethod	None.
Status	PaymentStatus	None.
Description	string	None.
EndDate	date	None.
PaymentPlanEndDate	date	None.
TotalAmount	decimal number	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
PostingDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "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-04T08:09:23.1742619+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-04T08:09:23.1742619+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-04T08:09:23.1742619+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:09:23 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:09:23.1742619+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:09:23 AM"
      }
    },
    {
      "paymentID": 1,
      "buid": 2,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:09:23.1742619+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:09:23 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:09:23.1742619+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:09:23 AM"
      }
    }
  ],
  "businessUnitNames": "sample string 2",
  "paymentMethod": 10,
  "status": 1,
  "description": "sample string 3",
  "endDate": "2024-12-04T08:09:23.1742619+00:00",
  "paymentPlanEndDate": "2024-12-04T08:09:23.1742619+00:00",
  "totalAmount": 1.0,
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T08:09:23.1742619+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:09:23 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:09:23.1742619+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:09:23 AM"
  },
  "postingDate": "2024-12-04T08:09:23.1742619+00:00"
}

application/xml, text/xml

Sample:

<DirectDebitPaymentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Billings.Models">
  <BusinessUnitNames>sample string 2</BusinessUnitNames>
  <Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
    <d2p1:DateUtc>2024-12-04T08:09:23.1742619+00:00</d2p1:DateUtc>
    <d2p1:UserName>sample string 2</d2p1:UserName>
  </Created>
  <Description>sample string 3</Description>
  <EndDate>2024-12-04T08:09:23.1742619+00:00</EndDate>
  <JournalIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </JournalIDs>
  <LastUpdated xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
    <d2p1:DateUtc>2024-12-04T08:09:23.1742619+00:00</d2p1:DateUtc>
    <d2p1:UserName>sample string 2</d2p1:UserName>
  </LastUpdated>
  <PaymentBusinessUnits>
    <PaymentBusinessUnitDTO>
      <BUID>2</BUID>
      <Created xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
        <d4p1:DateUtc>2024-12-04T08:09:23.1742619+00:00</d4p1:DateUtc>
        <d4p1:UserName>sample string 2</d4p1:UserName>
      </Created>
      <LastUpdated xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
        <d4p1:DateUtc>2024-12-04T08:09:23.1742619+00:00</d4p1:DateUtc>
        <d4p1:UserName>sample string 2</d4p1:UserName>
      </LastUpdated>
      <PaymentID>1</PaymentID>
      <RecordState>Active</RecordState>
    </PaymentBusinessUnitDTO>
    <PaymentBusinessUnitDTO>
      <BUID>2</BUID>
      <Created xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
        <d4p1:DateUtc>2024-12-04T08:09:23.1742619+00:00</d4p1:DateUtc>
        <d4p1:UserName>sample string 2</d4p1:UserName>
      </Created>
      <LastUpdated xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
        <d4p1:DateUtc>2024-12-04T08:09:23.1742619+00:00</d4p1:DateUtc>
        <d4p1:UserName>sample string 2</d4p1:UserName>
      </LastUpdated>
      <PaymentID>1</PaymentID>
      <RecordState>Active</RecordState>
    </PaymentBusinessUnitDTO>
  </PaymentBusinessUnits>
  <PaymentID>1</PaymentID>
  <PaymentItems i:nil="true" />
  <PaymentMethod>Cash</PaymentMethod>
  <PaymentPlanEndDate>2024-12-04T08:09:23.1742619+00:00</PaymentPlanEndDate>
  <PostingDate>2024-12-04T08:09:23.1742619+00:00</PostingDate>
  <RecordState>Active</RecordState>
  <Status>Draft</Status>
  <TotalAmount>1</TotalAmount>
  <AdHocInvoices xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AdHocInvoices>
  <BusinessUnitStatusTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BusinessUnitStatusTypes>
  <DirectDebitInvoices xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DirectDebitInvoices>
  <FunderIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FunderIDs>
  <ResidentTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ResidentTypes>
  <SelectedBusinessUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1: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-04T08:09:23.1742619+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-04T08:09:23.1742619+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>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��T�n�0���*	I�y���C��OE��MYH�@.����~R�K۪)����o���r8�ѯ?W�C0,�/[��j������L�|P��!g_����Yb�\RE�W��ə
��6*����P��U]7$"�+֪ez�T+[�X!�R"4�"�J�M����
�H���T�\�=]�V�	쬹�����Z1!̭�Q�%5�^�La:Gr9=�O��e��
99Sy.��q^pN,ոhi��<g."
��f^w�H�"�� ;���,�u~��-|x��3*���������ף��[�譪��k�W�V�LNV��$6@�Am�ъiz�cu�11��{���4�/�X�l&���,��fg׷l�݀y�߆���?Z���?�/�}�ͥQ��&*5�ʛ��#���`�+��K��*":�}�I}
�q�Ӻ��t����&��T

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.