credit_notes

Create /credit_notes

Create a credit note. Required: contact (client UUID), date, and items (at least one line). Optional: currency (tenant default when omitted), invoice, project, assignee, notes, addresses, organization. Returns record with the detail projection.

POST

/credit_notes

curl --request POST \
  --url https://default.hannacrm.app/api/v4/credit_notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adminnote": "<string>",
  "assignee": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billing_city": "<string>",
  "billing_country": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billing_state": "<string>",
  "billing_street": "<string>",
  "billing_zip": "<string>",
  "clientnote": "<string>",
  "contact": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "date": "<string>",
  "invoice": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "items": [
    {
      "code": "<string>",
      "description": "<string>",
      "item": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "item_code": "<string>",
      "long_description": "<string>",
      "product_discount": 123,
      "qty": 123,
      "rate": 123,
      "unit": "<string>",
      "vat_percent": 123,
      "warehouse": "<string>"
    }
  ],
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_no": "<string>",
  "shipping_city": "<string>",
  "shipping_country": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shipping_state": "<string>",
  "shipping_street": "<string>",
  "shipping_zip": "<string>",
  "status": 123,
  "terms": "<string>"
}
'

{
  "record": {
    "adjustment": "<string>",
    "adminnote": "<string>",
    "assignee": [
      {}
    ],
    "billing_address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "client": [
      {}
    ],
    "clientnote": "<string>",
    "contact": [
      {}
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "currency": {
      "name": "<string>",
      "symbol": "<string>"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "date": "<string>",
    "discount_percent": "<string>",
    "discount_total": "<string>",
    "discount_type": "<string>",
    "document_full_number": "<string>",
    "document_number": "<string>",
    "document_prefix": "<string>",
    "invoice": {
      "document_full_number": "<string>",
      "uuid": "<string>"
    },
    "is_reverse_vat": "<string>",
    "items": [
      {}
    ],
    "organization": [
      {}
    ],
    "organization_name": "<string>",
    "project": {
      "name": "<string>",
      "uuid": "<string>"
    },
    "reference_no": "<string>",
    "remaining_amount": "<string>",
    "shipping_address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "status": "<string>",
    "subtotal": "<string>",
    "terms": "<string>",
    "total": "<string>",
    "total_tax": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "<string>"
  }

Autorizacijos

Authorizationstringheaderprivaloma

API key (Bearer token) created in Setup → API & MCP.

Turinys

adminnotestring

Internal admin note.

assigneestring

Assignee staff UUID.

billing_citystring

Billing city.

billing_countrystring

Billing country UUID.

billing_statestring

Billing state/region.

billing_streetstring

Billing street address.

billing_zipstring

Billing ZIP/postal code.

clientnotestring

Note visible to client.

contactstringprivaloma

Client UUID.

currencystring

Currency name (e.g. EUR). Uses tenant default when omitted on create.

custom_fieldsobject[]

Custom field values by slug.

Rodyti: child attributes

datestringprivaloma

Credit note date (Y-m-d).

invoicestring

Related invoice UUID. When set on create, credit may be auto-applied to the invoice.

itemsobject[]privaloma

Credit note line items. At least one object is required.

Rodyti: child attributes

organizationstring

Organization UUID.

projectstring

Related project UUID.

reference_nostring

Reference number.

shipping_citystring

Shipping city.

shipping_countrystring

Shipping country UUID.

shipping_statestring

Shipping state/region.

shipping_streetstring

Shipping street address.

shipping_zipstring

Shipping ZIP/postal code.

statusinteger

Credit note status code (1=open, 2=closed, 3=void).

termsstring

Terms and conditions.

Atsakymas

Success

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Rodyti: child attributes

Vis dar reikia pagalbos? Klausti komandos