--- title: "Update Credit Note" method: PATCH path: "/v1/accounting/sales-credit-note/{id}" tags: ["API / Accounting", "Use case / Accounting"] --- # Update Credit Note `PATCH /v1/accounting/sales-credit-note/{id}` ## Path parameters - `id` string, uuid, required ## Request body - SalesCreditNotePatchInput - `custom_fields` object — User defined additional fields. ## Response `200` Successful Response - SalesCreditNoteOutput - `date` string, date, required — Credit note date - `booking_date` string, date, nullable — booking date needs to be enabled else this will default to the date field - `currency` string, required - `custom_fields` object - `customer_reference_numbers` string[] - `id` string, uuid, nullable, required — Technical id within the Qargo system - `name` string, required - `e_invoicing` EInvoicingOutput - `number` string, nullable — E-invoicing registration number. - `url` string, nullable — E-invoicing verification URL. - `regulator` string, nullable — E-invoicing regulator. - `exchange_rate` ExchangeRate - `rate_date` string, date, nullable - `rate` number, required - `inverse_rate` number, required - `total_excl_tax` string, required - `total_incl_tax` string, required - `total_tax` string, required - `customer` CompanySummaryOutput, required - `id` string, uuid, required — The unique identifier of the company. - `code` string, nullable — External reference to this company record - `currency` string, required — Currency of the company (ISO 4217, 3 letter code) - `custom_fields` object, nullable — Custom fields of the company - `is_customer` boolean — Indicate that this company is a customer - `is_subcontractor` boolean — Indicate that this company is a subcontractor (supplier) - `is_buyer_or_seller` boolean, nullable — Indicates that this company is a buyer or seller of a consignment - `name` string, required — Name of the company. - `legal_name` string, nullable — Legal name of the company. - `vat_number` string, nullable — VAT number of the company. - `note` string, nullable — Additional notes about the company - `tax_type` 'VAT' | 'REVERSE_CHARGE' | 'TRANSIT' | 'NO_VAT' | 'CO_CONTRACTING' | 'OTHER' - `status` 'PROSPECT' | 'NOT_APPROVED' | 'APPROVED' | 'WARNING' | 'BLOCKED' - `accounting_code` string, nullable — Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides. - `billing_location` LocationOutput - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set. - `display_name` string, nullable — Human-readable label for a location in operational views. - `external_id` string, nullable — Identifier from an external (master data) system. - `address` string, nullable — First address line of the location - `address_second_line` string, nullable — Second address line of the location - `city` string, nullable — City of the location - `state` string, nullable — State of the location - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location - `postal_code` string, nullable — Postal code of the location - `name` string, nullable — Name of the location - `id` string, uuid, nullable — Unique identifier of the location - `latitude` number, nullable — Latitude of the location - `longitude` number, nullable — Longitude of the location - `payment_term` BasePaymentTerm - `code` 'END_OF_MONTH_2' | 'END_OF_MONTH_1' | 'END_OF_MONTH_0_NET_90' | 'END_OF_MONTH_0_NET_75' | 'END_OF_MONTH_0_NET_70' | 'END_OF_MONTH_0_NET_65' | 'END_OF_MONTH_0_NET_60' | 'END_OF_MONTH_0_NET_50' | 'END_OF_MONTH_0_NET_45' | 'END_OF_MONTH_0_NET_35' | 'END_OF_MONTH_0_NET_31' | 'END_OF_MONTH_0_NET_30' | 'END_OF_MONTH_0_NET_25' | 'END_OF_MONTH_0_NET_21' | 'END_OF_MONTH_0_NET_20' | 'END_OF_MONTH_0_NET_14' | 'END_OF_MONTH_0_NET_7' | 'END_OF_MONTH_0_NET_1' | 'END_OF_MONTH_0' | 'PREPAID' | 'CUSTOM_DUE_DATE' | 'UPON_RECEIPT' | 'NET_1' | 'NET_2' | 'NET_3' | 'NET_5' | 'NET_7' | 'NET_8' | 'NET_10' | 'NET_12' | 'NET_14' | 'NET_15' | 'NET_20' | 'NET_21' | 'NET_28' | 'NET_30' | 'NET_35' | 'NET_40' | 'NET_42' | 'NET_45' | 'NET_48' | 'NET_49' | 'NET_50' | 'NET_52' | 'NET_55' | 'NET_56' | 'NET_60' | 'NET_63' | 'NET_70' | 'NET_75' | 'NET_77' | 'NET_80' | 'NET_84' | 'NET_90' | 'NET_91' | 'NET_98' | 'NET_120', required - `is_blocked` boolean — Set to true to disallow new order creation for companies representing companies. **Note**: Deprecated in favor of `status`. - `line_items` LineItem[], required - `id` string, uuid, nullable, required — Unique id of this line item. A Qargo invoice line can be represented with multiple LineItems if revenue/cost split is enabled. - `invoice_line_id` string, uuid, nullable, required — Technical id of the invoice within the Qargo system - `name` string, required — Name of the charge line. - `amount` string, required — Amount of the charge line. - `code` string, required — Code of the type of charge line. - `account` ApiOrderModelsChargeAccountOutput - `code` string, nullable — Accounting code - `description` string, nullable — Freeform description field - `tax_rate` ApiAccountingModelsInvoiceTaxRate - `id` string, uuid, nullable — Unique identifier of the tax rate in Qargo. - `name` string, nullable — Name of the Tax rate in Qargo. - `percentage` number, nullable - `code` string, nullable — Code of the tax rate item in the accounting software. - `tax_type` 'VAT' | 'NO_VAT' | 'REVERSE_CHARGE' | 'TRANSIT' | 'CO_CONTRACTING' | 'OTHER' - `base_tax_rate` BaseTaxRate — Original base tax rate, before applying customer/transport specific tax rules. - `percentage` number, nullable - `order_name` string, nullable — Name of the Qargo order linked to this line item. For purchase invoices, this is an empty string when `order_id` is `null`. - `order_id` string, uuid, nullable — ID of the Qargo order linked to this line item. For purchase invoices, this is `null` when charges are not calculated per order and the line item is not split per order. - `trip_id` string, uuid, nullable — Linked Qargo trip id, for cost charges - `is_credit_charge` boolean - `invoice_name` string, nullable — Name of the source invoice this line item is linked to, if applicable. - `currency` string, required - `fraction` string — The api can split the charge lines according to revenue. This fraction indicates the percentage of the total amount of the split for this set of dimensions. - `dimension_1` string, nullable - `dimension_2` string, nullable - `dimension_3` string, nullable - `dimension_4` string, nullable - `dimension_5` string, nullable - `dimension_6` string, nullable - `billing_entity` BillingEntity, required - `id` string, uuid, required — Unique identifier of the billing entity in Qargo. - `legal_name` string, required — Legal name of the billing entity. - `vat_number` string, required — VAT number of the billing entity. - `code` string, required — Code of the billing entity. - `company_registration_number` string, required — Company registration number of the billing entity. - `is_default` boolean — Indicates whether this billing entity is the default one. ## Other responses - `400` — Bad Request — invalid input or malformed request - `401` — Unauthorized — missing or invalid authentication credentials - `403` — Forbidden — insufficient permissions for this operation - `422` — Validation Error - `429` — Too Many Requests — rate limit exceeded. See the `Retry-After` header - `500` — Internal Server Error - `503` — Service Unavailable — temporarily unable to handle the request --- [API](https://skmtc.dev/qargo/apis/qargo-tms-api.md) · [All operations](https://skmtc.dev/qargo/apis/qargo-tms-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/qargo/qargo-tms-api/revisions/17297902e7ce/schema)