PApaypal
Credit Notes

Get all credit notes

get/credit-notes

Request

Query parameters

per_pageinteger

Number of records per page

pageinteger

Page number

external_customer_idstring

Filter credit notes by external customer ID

invoice_idstring

Filter credit notes by invoice ID

status'DRAFT' | 'FINALIZED' | 'VOIDED'

Status values for filtering credit notes

Example:FINALIZED

Filter credit notes by status

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

The status of the credit portion of the credit note

Example:AVAILABLE

Filter credit notes by credit status (e.g., available, consumed, voided)

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

The status of the refund portion of the credit note

Example:PENDING

Filter credit notes by refund status

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

The reason for credit note creation

Example:OTHER

Filter credit notes by reason

idstring

Filter credit notes by ID

numberstring

Filter credit notes by credit note number

issuing_date_fromstring date-time

Date and time in ISO 8601 format.

Example:2023-10-01T12:00:00Z

Filter credit notes issued on or after this date (ISO 8601 format)

issuing_date_tostring date-time

Date and time in ISO 8601 format.

Example:2023-10-01T12:00:00Z

Filter credit notes issued on or before this date (ISO 8601 format)

created_at_fromstring date-time

Date and time in ISO 8601 format.

Example:2023-10-01T12:00:00Z

Filter credit notes created on or after this date (ISO 8601 format)

created_at_tostring date-time

Date and time in ISO 8601 format.

Example:2023-10-01T12:00:00Z

Filter credit notes created on or before this date (ISO 8601 format)

updated_at_fromstring date-time

Date and time in ISO 8601 format.

Example:2023-10-01T12:00:00Z

Filter credit notes updated on or after this date (ISO 8601 format)

updated_at_tostring date-time

Date and time in ISO 8601 format.

Example:2023-10-01T12:00:00Z

Filter credit notes updated on or before this date (ISO 8601 format)

Response

A list of credit notes.

Example response

{
  "credit_notes": [
    {
      "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.