POST api/invoice/raisecreditnote

Raise a credit note against invoice items on an invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The raise credit note data contract supplied with the request.

RaiseCreditNoteDataContract

Name	Description	Type	Additional information
DateTime	The date time, expressed as a date and time.	date	None.
IssuingParty	The issuing party classification.	IssuingParty	None.
ReceipientAccountId	The unique identifier of the related receipient account resource.	integer	None.
Description	The description value.	string	None.
Items	The collection of items.	Collection of CreditNoteItemDataContract	None.
Reason	The reason value.	string	None.
IssueRefund	Indicates whether this item is sue refund.	boolean	None.
FundRefundFromAgencyFunds	Indicates whether fund refund from agency funds is true.	boolean	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "DateTime": "2026-07-23T10:34:42.3848576Z",
  "IssuingParty": 0,
  "ReceipientAccountId": 2,
  "Description": "sample string 3",
  "Items": [
    {
      "InvoiceItemId": 1,
      "Amount": 2.0,
      "LiabilityAccountType": 0
    },
    {
      "InvoiceItemId": 1,
      "Amount": 2.0,
      "LiabilityAccountType": 0
    }
  ],
  "Reason": "sample string 4",
  "IssueRefund": true,
  "FundRefundFromAgencyFunds": true
}

Response Information

Resource Description

The response returned after the operation completes.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.