Credit Notes: Updates an existing credit note by id.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a CreditNoteUpdateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/invoicing/credit-notes/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "reason": "Goodwill credit for a late delivery, revised amount.",
  "lineItems": [
    {
      "description": "Goodwill credit for a late delivery",
      "quantity": 1,
      "unitPrice": 100.00,
      "taxAmount": 8.25
    }
  ]
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "reason": "Goodwill credit for a late delivery, revised amount.",
  "lineItems": [
    {
      "description": "Goodwill credit for a late delivery",
      "quantity": 1,
      "unitPrice": 100.00,
      "taxAmount": 8.25
    }
  ]
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/invoicing/credit-notes/{id}' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, InvoicingApi } from '@winkpg/winkpg-api';

const api = new InvoicingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.creditNoteUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "reason": "Goodwill credit for a late delivery, revised amount.",
  "lineItems": [
    {
      "description": "Goodwill credit for a late delivery",
      "quantity": 1,
      "unitPrice": 100.00,
      "taxAmount": 8.25
    }
  ]
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/credit-notes/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
    "reason": "Goodwill credit for a late delivery, revised amount.",
    "lineItems": [
      {
        "description": "Goodwill credit for a late delivery",
        "quantity": 1,
        "unitPrice": 100.00,
        "taxAmount": 8.25
      }
    ]
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new InvoicingApi(config);
var body = JsonSerializer.Deserialize<CreditNoteUpdateDto>("""
    {
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "reason": "Goodwill credit for a late delivery, revised amount.",
      "lineItems": [
        {
          "description": "Goodwill credit for a late delivery",
          "quantity": 1,
          "unitPrice": 100.00,
          "taxAmount": 8.25
        }
      ]
    }
    """);

var result = await api.CreditNoteUpdateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/invoicing/credit-notes/{id}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "reason": "Goodwill credit for a late delivery, revised amount.",
      "lineItems": [
        {
          "description": "Goodwill credit for a late delivery",
          "quantity": 1,
          "unitPrice": 100.00,
          "taxAmount": 8.25
        }
      ]
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.InvoicingApi(client)
    body = winkpg_api.CreditNoteUpdateDto.from_dict({
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "reason": "Goodwill credit for a late delivery, revised amount.",
      "lineItems": [
        {
          "description": "Goodwill credit for a late delivery",
          "quantity": 1,
          "unitPrice": 100.00,
          "taxAmount": 8.25
        }
      ]
    })
    result = api.credit_note_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "reason": "Goodwill credit for a late delivery, revised amount.",
  "lineItems": [
    {
      "description": "Goodwill credit for a late delivery",
      "quantity": 1,
      "unitPrice": 100.00,
      "taxAmount": 8.25
    }
  ]
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/invoicing/credit-notes/{id}",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

id required

path

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

reason required

string

nullablemax length 1000

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lineItems required

array of CreditNoteLineItemInputDto array of CreditNoteLineItemInputDto

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each CreditNoteLineItemInputDto:

Field Type Description

originalLineItemId required

string (uuid)

The invoice line being credited. When set, the tax is derived from that line at its effective rate and the credit cannot exceed the line's net plus tax. Leave null for a free-form credit. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

nullablemax length 500

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

quantity required

number (double)

greater than 0

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitPrice required

number (double)

Price per unit credited. May carry more than two decimals; the line's net is rounded to the cent.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxAmount required

number (double)

Tax credited on this line. Honoured, rounded to the cent and floored at zero, only on a free-form line; on a line that references an original invoice line it is ignored and derived server-side.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lineTotal required

number (double)

Ignored. The persisted line total is always computed server-side and returned on the response. Kept so existing requests keep deserialising.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

concurrencyStamp required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This request body has no documented fields.

Responses

200 OK

OK

Body: CreditNoteDto CreditNoteDto Each item has these fields.

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creationTime required

string (date-time)

The date and time when this entity was created.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creatorId required

string (uuid)

The ID of the user who created this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModificationTime required

string (date-time)

The date and time when this entity was last modified. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModifierId required

string (uuid)

The ID of the user who last modified this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerId required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerType required

InvoicePartyType InvoicePartyType

Identifies the type of entity acting as the biller or recipient on an invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`GatewayOwner`	Platform-level gateway owner.
`Reseller`	Reseller entity.
`Merchant`	Merchant entity.
`Customer`	End customer.

creditNoteNumber required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

originalInvoiceId required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

customerId required

string (uuid)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

reason required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lineItems required

array of CreditNoteLineItemDto array of CreditNoteLineItemDto

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each CreditNoteLineItemDto:

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

originalLineItemId required

string (uuid)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

quantity required

number (double)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitPrice required

number (double)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxAmount required

number (double)

Tax credited on this line, as computed server-side.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lineTotal required

number (double)

Net plus tax credited on this line, as computed server-side.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

total required

number (double)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

status required

CreditNoteStatus CreditNoteStatus

Lifecycle status of a credit note.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Draft`	Created, not yet issued.
`Issued`	Issued and available to apply.
`Applied`	Applied to the original invoice.
`Voided`	Voided and no longer valid.

issuedAt required

string (date-time)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

appliedAt required

string (date-time)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 Too Many Requests

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors 400 401 403 404 409 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
409 Conflict Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Invoicing

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Credit Notes: Updates an existing credit note by id.

Example request

Parameters

Request body

Responses

Errors

Authentication