POST Payment/PostPrepayPayment

Creates a new Prepay payment on a booking.

Request Information

URI Parameters

Body Parameters

PostPrepayPayment object used to create a new payment.

Name	Description	Type	Additional Information
PaymentLocation	The Agvance location of the payment.	string	Required Max length: 6
PaymentDate	The date of the payment.	string	Required Data type: DateTime Format must be MM/dd/yyyy
CustomerID	The Agvance customer ID the payment is for.	string	Required Max length: 6
TotalPaymentAmount	The total amount of the payment.	decimal number	Required Max length: 15 Max of 2 decimal places Must be filled out and numeric
TotalDiscountAmount	The total amount of the discount on the payment.	decimal number	Max length: 15 Max of 2 decimal places Must be numeric
DiscountGLAccount	The GL account that the discount will post to.	string
Description	The user entered notes about the payment.	string	Max length: 500
UnappliedCash		decimal number
ControlNumber	The control number on the payment.	string	Max length: 10
PrepayPaymentRecordLineItemDetailsAdd		Collection of clsPrepayPaymentDetailsAdd	JSON list name must be PrepayPaymentRecordLineItemDetailsAdd.
PrepayPaymentRecordPayMethodsAdd		Collection of clsPrepayPaymentPayMethodsAdd	JSON list name must be PrepayPaymentRecordPayMethodsAdd.

Request Formats

application/json, text/json

Sample:

{
  "PaymentLocation": "sample string 4",
  "PaymentDate": "sample string 5",
  "CustomerID": "sample string 7",
  "TotalPaymentAmount": 8.1,
  "TotalDiscountAmount": 9.1,
  "DiscountGLAccount": "sample string 10",
  "Description": "sample string 12",
  "UnappliedCash": 17.1,
  "ControlNumber": "sample string 20",
  "PrepayPaymentRecordLineItemDetailsAdd": [
    {
      "BookDate": "sample string 1",
      "BookNumber": 2,
      "BookLocation": "sample string 3",
      "DiscountAmount": 4.1,
      "PaymentAmount": 5.1,
      "BookLineItems": [
        1,
        2
      ]
    },
    {
      "BookDate": "sample string 1",
      "BookNumber": 2,
      "BookLocation": "sample string 3",
      "DiscountAmount": 4.1,
      "PaymentAmount": 5.1,
      "BookLineItems": [
        1,
        2
      ]
    }
  ],
  "PrepayPaymentRecordPayMethodsAdd": [
    {
      "PaymentMethod": "sample string 1",
      "Amount": 2.1,
      "Reference": "sample string 3"
    },
    {
      "PaymentMethod": "sample string 1",
      "Amount": 2.1,
      "Reference": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<PrepayPaymentRecordHeaderDetailsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.AR.Payment">
  <ControlNumber>sample string 20</ControlNumber>
  <CustomerID>sample string 7</CustomerID>
  <Description>sample string 12</Description>
  <DiscountGLAccount>sample string 10</DiscountGLAccount>
  <PaymentDate>sample string 5</PaymentDate>
  <PaymentLocation>sample string 4</PaymentLocation>
  <PrepayPaymentRecordLineItemDetailsAdd>
    <PrepayPaymentDtAdd>
      <BookDate>sample string 1</BookDate>
      <BookLineItems xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </BookLineItems>
      <BookLocation>sample string 3</BookLocation>
      <BookNumber>2</BookNumber>
      <DiscountAmount>4.1</DiscountAmount>
      <PaymentAmount>5.1</PaymentAmount>
    </PrepayPaymentDtAdd>
    <PrepayPaymentDtAdd>
      <BookDate>sample string 1</BookDate>
      <BookLineItems xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </BookLineItems>
      <BookLocation>sample string 3</BookLocation>
      <BookNumber>2</BookNumber>
      <DiscountAmount>4.1</DiscountAmount>
      <PaymentAmount>5.1</PaymentAmount>
    </PrepayPaymentDtAdd>
  </PrepayPaymentRecordLineItemDetailsAdd>
  <PrepayPaymentRecordPayMethodsAdd>
    <PrepayPaymentPayMethodAdd>
      <Amount>2.1</Amount>
      <PaymentMethod>sample string 1</PaymentMethod>
      <Reference>sample string 3</Reference>
    </PrepayPaymentPayMethodAdd>
    <PrepayPaymentPayMethodAdd>
      <Amount>2.1</Amount>
      <PaymentMethod>sample string 1</PaymentMethod>
      <Reference>sample string 3</Reference>
    </PrepayPaymentPayMethodAdd>
  </PrepayPaymentRecordPayMethodsAdd>
  <TotalDiscountAmount>9.1</TotalDiscountAmount>
  <TotalPaymentAmount>8.1</TotalPaymentAmount>
  <UnappliedCash>17.1</UnappliedCash>
</PrepayPaymentRecordHeaderDetailsAdd>

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

Response Information

Resource Description

Creates a new Prepay payment on a booking.

AgvPayment

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
ErrorList	List of error messages of the API call.	Collection of string
WarningList	List of warning messages of the API call.	Collection of string
Count	Count of how many Payments.	string
PaymentRecords	JSON dictionary of PaymentRecords.	Collection of clsAPIPayment

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "PaymentRecords": [
    {
      "PaymentDate": "sample string 1",
      "PaymentLocation": "sample string 2",
      "PaymentNumber": "sample string 3",
      "PaymentRecordHeaderDetails": null,
      "PaymentRecordPayMethodDetails": [],
      "PaymentRecordLineItemDetails": []
    },
    {
      "PaymentDate": "sample string 1",
      "PaymentLocation": "sample string 2",
      "PaymentNumber": "sample string 3",
      "PaymentRecordHeaderDetails": null,
      "PaymentRecordPayMethodDetails": [],
      "PaymentRecordLineItemDetails": []
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.