POST api/CreditNote/AddCreditNoteWithItems

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CompanyId	integer	None.
ClientId	integer	None.
IssueDate	date	None.
DueDate	date	None.
CreditNoteNumber	integer	None.
BankAccountId	integer	None.
CreditNotePrefix	string	None.
AcctTeamId	integer	None.
CurrencyCode	string	None.
Notes	string	None.
CreditNoteItems	Collection of NewAddCreditNoteItemModel	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyId": 1,
  "ClientId": 1,
  "IssueDate": "2025-05-02T17:28:40.0876346+01:00",
  "DueDate": "2025-05-02T17:28:40.0876346+01:00",
  "CreditNoteNumber": 1,
  "BankAccountId": 1,
  "CreditNotePrefix": "sample string 1",
  "AcctTeamId": 2,
  "CurrencyCode": "sample string 3",
  "Notes": "sample string 4",
  "CreditNoteItems": [
    {
      "Product": "sample string 1",
      "ProductId": 1,
      "Quantity": 1.0,
      "ProductRate": 1.1,
      "VatRate": 1.1,
      "Description": "sample string 2"
    },
    {
      "Product": "sample string 1",
      "ProductId": 1,
      "Quantity": 1.0,
      "ProductRate": 1.1,
      "VatRate": 1.1,
      "Description": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<AddCreditNoteWithItemsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Focus247_2022.CreditNoteModels">
  <AcctTeamId>2</AcctTeamId>
  <BankAccountId>1</BankAccountId>
  <ClientId>1</ClientId>
  <CompanyId>1</CompanyId>
  <CreditNoteItems>
    <NewAddCreditNoteItemModel>
      <Description>sample string 2</Description>
      <Product>sample string 1</Product>
      <ProductId>1</ProductId>
      <ProductRate>1.1</ProductRate>
      <Quantity>1</Quantity>
      <VatRate>1.1</VatRate>
    </NewAddCreditNoteItemModel>
    <NewAddCreditNoteItemModel>
      <Description>sample string 2</Description>
      <Product>sample string 1</Product>
      <ProductId>1</ProductId>
      <ProductRate>1.1</ProductRate>
      <Quantity>1</Quantity>
      <VatRate>1.1</VatRate>
    </NewAddCreditNoteItemModel>
  </CreditNoteItems>
  <CreditNoteNumber>1</CreditNoteNumber>
  <CreditNotePrefix>sample string 1</CreditNotePrefix>
  <CurrencyCode>sample string 3</CurrencyCode>
  <DueDate>2025-05-02T17:28:40.0876346+01:00</DueDate>
  <IssueDate>2025-05-02T17:28:40.0876346+01:00</IssueDate>
  <Notes>sample string 4</Notes>
</AddCreditNoteWithItemsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.