PApaypal
Credit Notes

Void a credit note

Voids a credit note, making it no longer available for use. This action cannot be undone.

post/credit-notes/{credit_note_id}/void

Request

Path parameters

credit_note_idstring required

The ID of the credit note to void

Response

Credit note voided successfully

billing_entity_codestring required

Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.

sequential_idinteger required

The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.

numberstring required

The credit note unique number.

invoice_idstring uuid required

Unique identifier assigned to the invoice that the credit note belongs to

invoice_numberstring required

The invoice unique number, related to the credit note.

issuing_datestring date required

Date in ISO 8601 format (YYYY-MM-DD).

credit_status'AVAILABLE' | 'CONSUMED' | 'VOIDED'

The status of the credit portion of the credit note

refund_status'PENDING' | 'SUCCEEDED' | 'FAILED'

The status of the refund portion of the credit note

reason'DUPLICATED_CHARGE' | 'PRODUCT_UNSATISFACTORY' | 'ORDER_CHANGE' | 'ORDER_CANCELLATION' | 'FRAUDULENT_CHARGE' | 'OTHER' required

The reason for credit note creation

descriptionstring nullable

The description of the credit note.

taxes_ratenumber required

The tax rate associated with this specific credit note.

created_atstring date-time required

Date and time in ISO 8601 format.

updated_atstring date-time required

Date and time in ISO 8601 format.

idstring

Example response

{
  "billing_entity_code": "acme_inc",
  "sequential_id": 2,
  "number": "PP-1234-US",
  "invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "invoice_number": "PP-1234",
  "issuing_date": "2023-10-01",
  "credit_status": "AVAILABLE",
  "refund_status": "PENDING",
  "reason": "OTHER",
  "description": "Free text",
  "total_amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "taxes_amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "taxes_rate": 0.2,
  "sub_total_excluding_taxes_amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "balance_amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "credit_amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "refund_amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "created_at": "2023-10-01T12:00:00Z",
  "updated_at": "2023-10-01T12:00:00Z",
  "items": [
    {
      "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "amount": {
        "value": 120.35,
        "currency_code": "USD"
      },
      "fee": {
        "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "total_amount": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "name": "Basic Plan"
      }
    }
  ],
  "applied_taxes": [
    {
      "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "tax_name": "TVA",
      "tax_code": "french_standard_vat",
      "tax_rate": 20,
      "tax_description": "French standard VAT",
      "amount": {
        "value": 120.35,
        "currency_code": "USD"
      },
      "created_at": "2023-10-01T12:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.