--- title: "Get an credit by ID" method: GET path: "/v1/salecredits/{id}" tags: ["SaleCredits"] deprecated: true --- # Get an credit by ID `GET /v1/salecredits/{id}` > **Deprecated.** **Deprecated** — use `/v1/SalesCredits/{id}` instead. This route still works and returns the same result; only the spelling of the resource changed. ## Path parameters - `id` integer, required ## Response `200` OK - Credit — Credit - `balance` number, double — Balance - `billingAddress` AddressFields - `city` string, nullable - `countryIso` string, nullable - `countryName` string, nullable - `formattedAddress` string, nullable - `inlineAddress` string, nullable - `street` string, nullable - `zipcode` string, nullable - `billingContact` ContactFields - `cellPhone` string, nullable - `companyName` string, nullable - `displayName` string, nullable - `email` string, nullable - `firstName` string, nullable - `function` string, nullable - `invertedDisplayName` string, nullable - `lastName` string, nullable - `phone` string, nullable - `service` string, nullable - `title` string, nullable - `cancellationInvoiceId` integer, nullable — ID of the invoice that cancelled this credit - `cancellationInvoiceNumber` string, nullable — Number of the invoice that cancelled this credit - `cancelledInvoicetId` integer, nullable — Invoice ID which this credit cancelled - `cancelledInvoicetNumber` string, nullable — Invoice number which this credit cancelled - `commitments` Commitment[], nullable — Commitments - `amount` number, double — Gets the total amount of the commitment. - `date` string, date — Gets the date of the commitment. - `dueAmount` number, double — Gets the amount that is due for the commitment. - `id` integer — Gets the unique identifier for the commitment. - `thirdId` number, double — Gets the identifier of the third party associated with the commitment. - `customerElectronicAddress` string, nullable — Customer electronic address - `customerId` integer, nullable — Customer ID - `customerName` string, nullable — Customer name - `customerNumber` string, nullable — Customer number - `customerOrderReference` string, nullable — Customer order reference - `customerSiret` string, nullable — Customer SIRET - `customerType` 'Business' | 'Consumer' | 'Government' - `customerVatNumber` string, nullable — Customer VAT number - `date` string, date, nullable — Date - `footerNotes` string, nullable — Footer notes to be print - `globalDiscount` Discount - `type` 'Percent' | 'Fixed' - `value` number, double - `grossTaxExcludedAmount` number, double — Gross tax excluded amount - `headerNotes` string, nullable — Header notes to be print - `id` integer — Invoice ID - `internalId` string, nullable — ID used in your system - `internalNotes` string, nullable — Internal notes - `isCancelled` boolean — True when this credit has itself been cancelled by an invoice - `isDraft` boolean — Indicates whether invoice is draft. Otherwise invoice cannot be modified - `isPaid` boolean — Indicates whether invoice is paid - `liableToVat` boolean, nullable — Indicates whether the document is liable to VAT - `lines` SaleDocumentLine[], nullable — Invoice lines - `classificationId` integer, nullable — Classification ID (used if no product is set) - `date` string, date, nullable — Date - `description` string, nullable — Description (can be html) - `discount` Discount - `type` 'Percent' | 'Fixed' - `value` number, double - `id` integer — Invoice line ID - `marginAmount` number, double — Margin amount - `markupRate` number, double — Markup rate: the margin as a percentage of the purchase price (FR « taux de marge »). Renamed from `marginRate`: it has always divided by the purchase price. - `product` Product — Product - `active` boolean — Indicates whether the product is active - `defaultQuantity` number, double — Default quantity - `description` string, nullable — Description - `family` ProductFamily — Product family - `id` integer — ID - `label` string, nullable — Label - `number` string, nullable — Number - `id` integer — Product ID - `imageUrl` string, nullable — Gets the product image URL - `internalId` string, nullable — ID used in your system - `internalNotes` string, nullable — Internal notes - `isUnitPriceTaxIncluded` boolean — Deprecated — always false on read, because `unitPrice` is now always the tax-excluded price. There is nothing left for it to select between. On write it is still honoured: setting it to true means the price you are sending is tax-included, exactly as before. Send `taxIncludedPrice` instead. - `margin` number, double — Margin per unit, excluding tax: tax-excluded price less purchase price. Derived by the server on every save; a value sent here is ignored. - `marginRate` number, double — Margin rate: the margin as a percentage of the sale price (FR « taux de marque »). Derived by the server on every save; a value sent here is ignored. - `markupRate` number, double — Markup rate: the margin as a percentage of the purchase price (FR « taux de marge »). Derived by the server on every save; a value sent here is ignored. - `metadata` object, nullable — Metadata: free-form key/value pairs carried with the product, for an integration to keep its own identifiers and flags against it. Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as `null`. Omitting the property entirely leaves the whole bag untouched, and `""` stores an empty value rather than removing the key. - `name` string, nullable — Name - `number` string, nullable — Number - `purchasePrice` number, double — Purchase price - `taxExcludedPrice` number, double — Sale price excluding tax. - `taxIncludedPrice` number, double — Sale price including tax. - `type` 'Product' | 'Service' | 'Text' - `unit` Unit — Unit - `code` string, nullable — Code - `conversion` number, double — Conversion - `decimals` number, double, nullable — Decimals - `id` integer, nullable — Unit Id - `name` string, nullable — Name - `type` 'Time' | 'Weight' | 'Area' | 'Volume' | 'Dimension' | 'Other' - `unitPrice` number, double — Deprecated — use `taxExcludedPrice`. Unit price, excluding tax: the same value as `taxExcludedPrice`. Still populated, and still read on write when neither new price field is sent, so no existing integration has to change today. It used to carry whichever half the product was edited in — the tax-included price when `isUnitPriceTaxIncluded` was true — because only one price was stored. Both are stored now, so this always reports the tax-excluded one and `isUnitPriceTaxIncluded` is always false: a client that reads the flag keeps computing the same result. - `vat` Vat — Vat - `default` boolean — Indicatess if this is the default VAT for the region - `id` integer, nullable — Vat ID - `label` string, nullable — Label - `rate` number, double, nullable — Rate - `region` 'FR' | 'EU' | 'IE' | 'DOM' | 'Corse' | 'Monaco' - `productId` integer, nullable — Product ID - `productInternalId` string, nullable — Product internal ID - `productNumber` string, nullable — Product number - `purchasePrice` number, double, nullable — Purchase price - `quantity` number, double, nullable — Quantity - `taxExcludedAmount` number, double, nullable — Tax excluded amount - `taxExcludedPrice` number, double, nullable — Tax excluded price - `taxIncludedAmount` number, double, nullable — Tax included amount - `taxIncludedPrice` number, double, nullable — Tax included price - `type` 'Empty' | 'Product' | 'Service' | 'Subtotal' | 'Text' | 'NewPage' — Line type - `unit` Unit — Unit - `code` string, nullable — Code - `conversion` number, double — Conversion - `decimals` number, double, nullable — Decimals - `id` integer, nullable — Unit Id - `name` string, nullable — Name - `type` 'Time' | 'Weight' | 'Area' | 'Volume' | 'Dimension' | 'Other' - `vat` Vat — Vat - `default` boolean — Indicatess if this is the default VAT for the region - `id` integer, nullable — Vat ID - `label` string, nullable — Label - `rate` number, double, nullable — Rate - `region` 'FR' | 'EU' | 'IE' | 'DOM' | 'Corse' | 'Monaco' - `metadata` object, nullable — Metadata: free-form key/value pairs carried with the document, for an integration to keep its own identifiers and flags against it. Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as `null`. Omitting the property entirely leaves the whole bag untouched, and `""` stores an empty value rather than removing the key. - `number` string, nullable — Number - `overdue` number, double — Overdue - `pdfUrl` string, nullable — Pdf url - `publicLink` string, nullable — Public link - `region` 'FR' | 'EU' | 'IE' | 'DOM' | 'Corse' | 'Monaco' - `replacedBy` integer, nullable — ID of the corrected credit that replaces this one - `sentAt` string, date-time, nullable — Sent at - `shippingAddress` AddressFields - `city` string, nullable - `countryIso` string, nullable - `countryName` string, nullable - `formattedAddress` string, nullable - `inlineAddress` string, nullable - `street` string, nullable - `zipcode` string, nullable - `shippingAmount` number, double — Shipping amount - `shippingContact` ContactFields - `cellPhone` string, nullable - `companyName` string, nullable - `displayName` string, nullable - `email` string, nullable - `firstName` string, nullable - `function` string, nullable - `invertedDisplayName` string, nullable - `lastName` string, nullable - `phone` string, nullable - `service` string, nullable - `title` string, nullable - `shippingVat` Vat — Vat - `default` boolean — Indicatess if this is the default VAT for the region - `id` integer, nullable — Vat ID - `label` string, nullable — Label - `rate` number, double, nullable — Rate - `region` 'FR' | 'EU' | 'IE' | 'DOM' | 'Corse' | 'Monaco' - `subject` string, nullable — Subject - `taxAmount` number, double — Total tax amount - `taxExcludedAmount` number, double — Tax excluded amount (discount included) - `taxIncludedAmount` number, double — Tax included amount - `useTaxIncludedPrices` boolean — Indicates whether invoice prices and amount are tax included - `vatMode` 'Auto' | 'Debit' | 'Collection' - `vatNote` string, nullable — VAT note to print - `vatReverseCharge` boolean — VAT reverse charge - `vats` VatSummary[], nullable — Vats - `taxExcludedAmount` number, double — Tax excluded amount - `vat` Vat — Vat - `default` boolean — Indicatess if this is the default VAT for the region - `id` integer, nullable — Vat ID - `label` string, nullable — Label - `rate` number, double, nullable — Rate - `region` 'FR' | 'EU' | 'IE' | 'DOM' | 'Corse' | 'Monaco' - `vatAmount` number, double — Vat amount - `vendorReference` string, nullable — Vendor reference to be print ## Other responses - `404` — Not Found ## Changes - **2026-09-14** `4f7fa64cf9e3` — 3 warning, 28 info - removed the optional property `lines/items/marginRate` from the response with the `200` status (media type: text/plain) - removed the optional property `lines/items/marginRate` from the response with the `200` status (media type: application/json) - removed the optional property `lines/items/marginRate` from the response with the `200` status (media type: text/json) - endpoint deprecated - …27 more - **2026-08-18** `e65392ac5b5f` — 12 info - added the optional property `cancellationInvoiceId` to the response with the `200` status (media type: text/plain) - added the optional property `cancellationInvoiceId` to the response with the `200` status (media type: application/json) - added the optional property `cancellationInvoiceId` to the response with the `200` status (media type: text/json) - added the optional property `cancellationInvoiceNumber` to the response with the `200` status (media type: text/plain) - …8 more [Change history](https://skmtc.dev/altoviz/apis/altoviz-api/changes/v1/salecredits/:id/get.md) --- [API](https://skmtc.dev/altoviz/apis/altoviz-api.md) · [All operations](https://skmtc.dev/altoviz/apis/altoviz-api/llms.txt) · [OpenAPI document](https://skmtc.dev/altoviz/apis/altoviz-api/revisions/4f7fa64cf9e3?raw)