POST customer/refund

By Customer Code, POST New Customer Refund

Request Information

URI Parameters

None.

Body Parameters

Interprise.Web.Services.Models.CustomerRefundInput

Name	Description	Type	Additional information
CustomerCode		string	None.
ReceivedFrom		string	None.
PaymentType		string	None.
AmountPaid		decimal number	None.
CurrencyExchangeRate		decimal number	None.
Notes		string	None.
CheckNumber		string	None.
IsDeposit	If unset or not specified, the value will default to payment type setting	boolean	None.
BankAccount		string	None.
PayingInSlip		string	None.
CustomFields	Collection of all the custom fields in PaymentMethod table	Collection of Interprise.Web.Services.Models.CustomField	None.

Request Formats

{
  "customerCode": "sample string 1",
  "receivedFrom": "sample string 2",
  "paymentType": "sample string 3",
  "amountPaid": 4.0,
  "currencyExchangeRate": 1.0,
  "notes": "sample string 5",
  "checkNumber": "sample string 6",
  "isDeposit": true,
  "bankAccount": "sample string 7",
  "payingInSlip": "sample string 8",
  "customFields": [
    {
      "field": "sample string 1",
      "value": {}
    },
    {
      "field": "sample string 1",
      "value": {}
    }
  ]
}

<CustomerRefundInput xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerCode>sample string 1</CustomerCode>
  <ReceivedFrom>sample string 2</ReceivedFrom>
  <PaymentType>sample string 3</PaymentType>
  <AmountPaid>4</AmountPaid>
  <CurrencyExchangeRate>1</CurrencyExchangeRate>
  <Notes>sample string 5</Notes>
  <CheckNumber>sample string 6</CheckNumber>
  <IsDeposit>true</IsDeposit>
  <BankAccount>sample string 7</BankAccount>
  <PayingInSlip>sample string 8</PayingInSlip>
  <CustomFields>
    <CustomField>
      <Field>sample string 1</Field>
      <Value />
    </CustomField>
    <CustomField>
      <Field>sample string 1</Field>
      <Value />
    </CustomField>
  </CustomFields>
</CustomerRefundInput>

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerRefundInput'.

Response Information

Resource Description

Interprise.Web.Services.Models.CustomerRefundResponse

Name	Type	Additional information
Result	Interprise.Web.Services.Models.CustomerRefundResponse+ResultResponse	None.
Counter	integer	None.
ReceivableCode	string	None.
Type	string	None.
CustomerCode	string	None.
ReceivedFrom	string	None.
Notes	string	None.
CurrencyCode	string	None.
ExchangeRate	decimal number	None.
OverPaymentAccountCode	string	None.
AmountPaid	decimal number	None.
AmountPaidRate	decimal number	None.
IsPosted	boolean	None.
DatePaid	date	None.
UserCreated	string	None.
DateCreated	date	None.
UserModified	string	None.
DateModified	date	None.

{
  "result": {
    "success": false
  },
  "counter": 1,
  "receivableCode": "sample string 2",
  "type": "sample string 3",
  "customerCode": "sample string 4",
  "receivedFrom": "sample string 5",
  "notes": "sample string 6",
  "currencyCode": "sample string 7",
  "exchangeRate": 1.0,
  "overPaymentAccountCode": "sample string 8",
  "amountPaid": 1.0,
  "amountPaidRate": 1.0,
  "isPosted": true,
  "datePaid": "2025-04-29T16:47:11.0347707+01:00",
  "userCreated": "sample string 9",
  "dateCreated": "2025-04-29T16:47:11.0347707+01:00",
  "userModified": "sample string 10",
  "dateModified": "2025-04-29T16:47:11.0347707+01:00"
}

<CustomerRefundResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Counter>1</Counter>
  <ReceivableCode>sample string 2</ReceivableCode>
  <Type>sample string 3</Type>
  <CustomerCode>sample string 4</CustomerCode>
  <ReceivedFrom>sample string 5</ReceivedFrom>
  <Notes>sample string 6</Notes>
  <CurrencyCode>sample string 7</CurrencyCode>
  <ExchangeRate>1</ExchangeRate>
  <OverPaymentAccountCode>sample string 8</OverPaymentAccountCode>
  <AmountPaid>1</AmountPaid>
  <AmountPaidRate>1</AmountPaidRate>
  <IsPosted>true</IsPosted>
  <DatePaid>2025-04-29T16:47:11.0347707+01:00</DatePaid>
  <UserCreated>sample string 9</UserCreated>
  <DateCreated>2025-04-29T16:47:11.0347707+01:00</DateCreated>
  <UserModified>sample string 10</UserModified>
  <DateModified>2025-04-29T16:47:11.0347707+01:00</DateModified>
</CustomerRefundResponse>