POST api/Adjustment?runDate={runDate}&uploadToKfs={uploadToKfs}

Request Information

URI Parameters

Name	Description	Type	Additional information
runDate		date	None.
uploadToKfs		boolean	Default value is True

Body Parameters

AdjustmentRequest

Name	Type	Additional information
OriginalDocOriginCode	string	Required
OriginalDocNumber	string	Required
OriginalGiftTransferRequest	BankTransferRequest	Required
BankTransferRequests	Collection of BankTransferRequest	Required
OriginalDescription	string	None.
OriginalOrgReferenceNum	string	None.
IsCcr	boolean	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "originalDocOriginCode": "sample string 1",
  "originalDocNumber": "sample string 2",
  "originalGiftTransferRequest": {
    "donorName": "sample string 1",
    "amount": 2.0,
    "allocationCode": "sample string 3",
    "departmentCode": "sample string 4",
    "agency": "sample string 5",
    "transactionId": "sample string 6",
    "kfsKey": "sample string 7",
    "authCode": "sample string 8",
    "authorizedAt": "2024-06-24T23:26:24.289733-07:00",
    "paymentType": 0,
    "merchantId": "sample string 10"
  },
  "bankTransferRequests": [
    {
      "donorName": "sample string 1",
      "amount": 2.0,
      "allocationCode": "sample string 3",
      "departmentCode": "sample string 4",
      "agency": "sample string 5",
      "transactionId": "sample string 6",
      "kfsKey": "sample string 7",
      "authCode": "sample string 8",
      "authorizedAt": "2024-06-24T23:26:24.289733-07:00",
      "paymentType": 0,
      "merchantId": "sample string 10"
    },
    {
      "donorName": "sample string 1",
      "amount": 2.0,
      "allocationCode": "sample string 3",
      "departmentCode": "sample string 4",
      "agency": "sample string 5",
      "transactionId": "sample string 6",
      "kfsKey": "sample string 7",
      "authCode": "sample string 8",
      "authorizedAt": "2024-06-24T23:26:24.289733-07:00",
      "paymentType": 0,
      "merchantId": "sample string 10"
    }
  ],
  "originalDescription": "sample string 3",
  "originalOrgReferenceNum": "sample string 4",
  "isCcr": false
}

application/xml, text/xml

Sample:

<AdjustmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GivingService.Models">
  <BankTransferRequests>
    <BankTransferRequest>
      <Agency>sample string 5</Agency>
      <AllocationCode>sample string 3</AllocationCode>
      <Amount>2</Amount>
      <AuthCode>sample string 8</AuthCode>
      <AuthorizedAt>2024-06-24T23:26:24.289733-07:00</AuthorizedAt>
      <DepartmentCode>sample string 4</DepartmentCode>
      <DonorName>sample string 1</DonorName>
      <KfsKey>sample string 7</KfsKey>
      <MerchantId>sample string 10</MerchantId>
      <PaymentType>Check</PaymentType>
      <TransactionId>sample string 6</TransactionId>
    </BankTransferRequest>
    <BankTransferRequest>
      <Agency>sample string 5</Agency>
      <AllocationCode>sample string 3</AllocationCode>
      <Amount>2</Amount>
      <AuthCode>sample string 8</AuthCode>
      <AuthorizedAt>2024-06-24T23:26:24.289733-07:00</AuthorizedAt>
      <DepartmentCode>sample string 4</DepartmentCode>
      <DonorName>sample string 1</DonorName>
      <KfsKey>sample string 7</KfsKey>
      <MerchantId>sample string 10</MerchantId>
      <PaymentType>Check</PaymentType>
      <TransactionId>sample string 6</TransactionId>
    </BankTransferRequest>
  </BankTransferRequests>
  <OriginalDescription>sample string 3</OriginalDescription>
  <OriginalDocNumber>sample string 2</OriginalDocNumber>
  <OriginalDocOriginCode>sample string 1</OriginalDocOriginCode>
  <OriginalGiftTransferRequest>
    <Agency>sample string 5</Agency>
    <AllocationCode>sample string 3</AllocationCode>
    <Amount>2</Amount>
    <AuthCode>sample string 8</AuthCode>
    <AuthorizedAt>2024-06-24T23:26:24.289733-07:00</AuthorizedAt>
    <DepartmentCode>sample string 4</DepartmentCode>
    <DonorName>sample string 1</DonorName>
    <KfsKey>sample string 7</KfsKey>
    <MerchantId>sample string 10</MerchantId>
    <PaymentType>Check</PaymentType>
    <TransactionId>sample string 6</TransactionId>
  </OriginalGiftTransferRequest>
  <OriginalOrgReferenceNum>sample string 4</OriginalOrgReferenceNum>
</AdjustmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.