Skip to content

Update Credit Note (Deprecated)
deprecated

Request

(deprecated, use /sales-credit-note/{id} instead)

Security
oAuth2ClientCredentials
Path
idstring, (uuid)(Id)required
Bodyapplication/jsonrequired
custom_fieldsobject(Custom Fields)

User defined additional fields.

PATCH
/v1/accounting/sales_credit_note/{id}
{
  "custom_fields": {}
}

Responses

Successful Response

Bodyapplication/json
datestring, (date)(Date)required

Credit note date

booking_datestring or null(Booking Date)
Any of:

booking date needs to be enabled else this will default to the date field

string (date)
currencystring(Currency)required
custom_fieldsobject(Custom Fields)
Default:{}
customer_reference_numbersArray of strings(Customer Reference Numbers)
idstring or null(Id)required
Any of:

Technical id within the Qargo system

string (uuid)
namestring(Name)required
e_invoicingEInvoicingOutput (object) or null
Any of:

E-invoicing registration metadata.

exchange_rateExchangeRate (object) or null
Any of:
total_excl_taxstring(Total Excl Tax)required
total_incl_taxstring(Total Incl Tax)required
total_taxstring(Total Tax)required
customerobject(CompanySummaryOutput)required
line_itemsArray of objects(Line Items)required
billing_entityobject(BillingEntity)required

Billing entity linked to this credit note.

Response
{
  "date": "2022-01-01",
  "booking_date": "2021-12-22",
  "currency": "EUR",
  "custom_fields": {},
  "customer_reference_numbers": [
    "12345"
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Credit-Note-0001",
  "e_invoicing": {
    "number": "string",
    "url": "string",
    "regulator": "string"
  },
  "exchange_rate": {
    "rate_date": "2022-01-01",
    "rate": 1,
    "inverse_rate": 1
  },
  "total_excl_tax": "100",
  "total_incl_tax": "121",
  "total_tax": "21",
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "",
    "currency": "EUR",
    "custom_fields": {},
    "is_customer": false,
    "is_subcontractor": false,
    "is_buyer_or_seller": true,
    "name": "John Doe",
    "legal_name": "John Doe",
    "vat_number": "BE1234.123.123",
    "note": "",
    "tax_type": "VAT",
    "status": "PROSPECT",
    "accounting_code": "1234",
    "billing_location": { … },
    "payment_term": { … },
    "is_blocked": false
  },
  "line_items": [
    { … }
  ],
  "billing_entity": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "legal_name": "Qargo BV",
    "vat_number": "NL123456789B01",
    "code": "QARGO",
    "company_registration_number": "12345678",
    "is_default": false
  }
}