POST api/WOInvoice/ReturnInvoice

API to return invoice

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceID	integer	None.
InvoiceReturnID	integer	None.
ReturnDate	date	None.
ReturnNo	string	None.
Note	string	None.
DamageAmount	decimal number	None.
DelayAmount	decimal number	None.
TotalAmount	decimal number	None.
PaidAmount	decimal number	None.
UserID	integer	None.
APIKey	string	None.
LocationID	integer	None.
SignatoryName	string	None.
SignatureDate	date	None.
SignaturePath	string	None.
ApproveSignatoryName	string	None.
ApproveSignatureDate	date	None.
ApproveSignaturePath	string	None.
EndSignatoryName	string	None.
EndSignatureDate	date	None.
EndSignaturePath	string	None.
PaymentMethodID	integer	None.
PaymentRefNo	string	None.
lstItem	Collection of InvoiceReturnItem	None.
CustomerID	integer	None.
CurrencyID	integer	None.
IsShowInCustomerPanel	boolean	None.
SendMailToCustomer	boolean	None.
SendMailToAdmin	boolean	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "invoiceID": 1,
  "invoiceReturnID": 1,
  "returnDate": "2025-07-17T04:46:17.1327423+00:00",
  "returnNo": "sample string 3",
  "note": "sample string 4",
  "damageAmount": 5.0,
  "delayAmount": 6.0,
  "totalAmount": 7.0,
  "paidAmount": 8.0,
  "userID": 9,
  "apiKey": "sample string 10",
  "locationID": 11,
  "signatoryName": "sample string 12",
  "signatureDate": "2025-07-17T04:46:17.1327423+00:00",
  "signaturePath": "sample string 13",
  "approveSignatoryName": "sample string 14",
  "approveSignatureDate": "2025-07-17T04:46:17.1327423+00:00",
  "approveSignaturePath": "sample string 15",
  "endSignatoryName": "sample string 16",
  "endSignatureDate": "2025-07-17T04:46:17.1327423+00:00",
  "endSignaturePath": "sample string 17",
  "paymentMethodID": 1,
  "paymentRefNo": "sample string 18",
  "lstItem": [
    {
      "invoiceRentalItemID": 1,
      "assetID": 2,
      "assetName": "sample string 3",
      "assetCode": "sample string 4",
      "isDamaged": true,
      "damageFee": 1.0,
      "damageReason": "sample string 6",
      "delayFee": 1.0,
      "delayReason": "sample string 7",
      "totalPrice": 8.0
    },
    {
      "invoiceRentalItemID": 1,
      "assetID": 2,
      "assetName": "sample string 3",
      "assetCode": "sample string 4",
      "isDamaged": true,
      "damageFee": 1.0,
      "damageReason": "sample string 6",
      "delayFee": 1.0,
      "delayReason": "sample string 7",
      "totalPrice": 8.0
    }
  ],
  "customerID": 19,
  "currencyID": 20,
  "isShowInCustomerPanel": true,
  "sendMailToCustomer": true,
  "sendMailToAdmin": true
}

application/xml, text/xml

Sample:

<InvoiceReturnInsertUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <APIKey>sample string 10</APIKey>
  <ApproveSignatoryName>sample string 14</ApproveSignatoryName>
  <ApproveSignatureDate>2025-07-17T04:46:17.1327423+00:00</ApproveSignatureDate>
  <ApproveSignaturePath>sample string 15</ApproveSignaturePath>
  <CurrencyID>20</CurrencyID>
  <CustomerID>19</CustomerID>
  <DamageAmount>5</DamageAmount>
  <DelayAmount>6</DelayAmount>
  <EndSignatoryName>sample string 16</EndSignatoryName>
  <EndSignatureDate>2025-07-17T04:46:17.1327423+00:00</EndSignatureDate>
  <EndSignaturePath>sample string 17</EndSignaturePath>
  <InvoiceID>1</InvoiceID>
  <InvoiceReturnID>1</InvoiceReturnID>
  <IsShowInCustomerPanel>true</IsShowInCustomerPanel>
  <LocationID>11</LocationID>
  <Note>sample string 4</Note>
  <PaidAmount>8</PaidAmount>
  <PaymentMethodID>1</PaymentMethodID>
  <PaymentRefNo>sample string 18</PaymentRefNo>
  <ReturnDate>2025-07-17T04:46:17.1327423+00:00</ReturnDate>
  <ReturnNo>sample string 3</ReturnNo>
  <SendMailToAdmin>true</SendMailToAdmin>
  <SendMailToCustomer>true</SendMailToCustomer>
  <SignatoryName>sample string 12</SignatoryName>
  <SignatureDate>2025-07-17T04:46:17.1327423+00:00</SignatureDate>
  <SignaturePath>sample string 13</SignaturePath>
  <TotalAmount>7</TotalAmount>
  <UserID>9</UserID>
  <lstItem>
    <InvoiceReturnItem>
      <AssetCode>sample string 4</AssetCode>
      <AssetID>2</AssetID>
      <AssetName>sample string 3</AssetName>
      <DamageFee>1</DamageFee>
      <DamageReason>sample string 6</DamageReason>
      <DelayFee>1</DelayFee>
      <DelayReason>sample string 7</DelayReason>
      <InvoiceRentalItemID>1</InvoiceRentalItemID>
      <IsDamaged>true</IsDamaged>
      <TotalPrice>8</TotalPrice>
    </InvoiceReturnItem>
    <InvoiceReturnItem>
      <AssetCode>sample string 4</AssetCode>
      <AssetID>2</AssetID>
      <AssetName>sample string 3</AssetName>
      <DamageFee>1</DamageFee>
      <DamageReason>sample string 6</DamageReason>
      <DelayFee>1</DelayFee>
      <DelayReason>sample string 7</DelayReason>
      <InvoiceRentalItemID>1</InvoiceRentalItemID>
      <IsDamaged>true</IsDamaged>
      <TotalPrice>8</TotalPrice>
    </InvoiceReturnItem>
  </lstItem>
</InvoiceReturnInsertUpdateModel>

multipart/form-data

Sample:

<InvoiceReturnInsertUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><APIKey>sample string 10</APIKey><ApproveSignatoryName>sample string 14</ApproveSignatoryName><ApproveSignatureDate>2025-07-17T04:46:17.1327423+00:00</ApproveSignatureDate><ApproveSignaturePath>sample string 15</ApproveSignaturePath><CurrencyID>20</CurrencyID><CustomerID>19</CustomerID><DamageAmount>5</DamageAmount><DelayAmount>6</DelayAmount><EndSignatoryName>sample string 16</EndSignatoryName><EndSignatureDate>2025-07-17T04:46:17.1327423+00:00</EndSignatureDate><EndSignaturePath>sample string 17</EndSignaturePath><InvoiceID>1</InvoiceID><InvoiceReturnID>1</InvoiceReturnID><IsShowInCustomerPanel>true</IsShowInCustomerPanel><LocationID>11</LocationID><Note>sample string 4</Note><PaidAmount>8</PaidAmount><PaymentMethodID>1</PaymentMethodID><PaymentRefNo>sample string 18</PaymentRefNo><ReturnDate>2025-07-17T04:46:17.1327423+00:00</ReturnDate><ReturnNo>sample string 3</ReturnNo><SendMailToAdmin>true</SendMailToAdmin><SendMailToCustomer>true</SendMailToCustomer><SignatoryName>sample string 12</SignatoryName><SignatureDate>2025-07-17T04:46:17.1327423+00:00</SignatureDate><SignaturePath>sample string 13</SignaturePath><TotalAmount>7</TotalAmount><UserID>9</UserID><lstItem><InvoiceReturnItem><AssetCode>sample string 4</AssetCode><AssetID>2</AssetID><AssetName>sample string 3</AssetName><DamageFee>1</DamageFee><DamageReason>sample string 6</DamageReason><DelayFee>1</DelayFee><DelayReason>sample string 7</DelayReason><InvoiceRentalItemID>1</InvoiceRentalItemID><IsDamaged>true</IsDamaged><TotalPrice>8</TotalPrice></InvoiceReturnItem><InvoiceReturnItem><AssetCode>sample string 4</AssetCode><AssetID>2</AssetID><AssetName>sample string 3</AssetName><DamageFee>1</DamageFee><DamageReason>sample string 6</DamageReason><DelayFee>1</DelayFee><DelayReason>sample string 7</DelayReason><InvoiceRentalItemID>1</InvoiceRentalItemID><IsDamaged>true</IsDamaged><TotalPrice>8</TotalPrice></InvoiceReturnItem></lstItem></InvoiceReturnInsertUpdateModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel

Name	Type	Additional information
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>