ALaltoviz
SaleCredits

List credits

Changed on

Deprecated — use /v1/SalesCredits instead. This route still works and returns the same result; only the spelling of the resource changed.

get/v1/salecredits

Request

Query parameters

PageIndexinteger
PageSizeinteger
OrderBystring
Fromstring date

From

Tostring date

To

CustomerIdinteger

Customer ID

Cancelled'Only' | 'Excluded' | 'All'

Tri-state filter for an optional category of documents (e.g. cancelled): Excluded (also the default when the parameter is omitted) hides them, Only returns just that category, All returns both.

Cancelled credits: Excluded (default, when omitted) hides them, Only returns just cancelled credits, All returns both.

Processed'Only' | 'Excluded' | 'All'

Tri-state filter for an optional category of documents (e.g. cancelled): Excluded (also the default when the parameter is omitted) hides them, Only returns just that category, All returns both.

Processed credits — those whose terminal e-invoicing status was taken into account ("traitées"): Excluded (default, when omitted) hides them, Only returns just processed credits, All returns both.

Response

OK

balancenumber double

Balance

cancellationInvoiceIdinteger nullable

ID of the invoice that cancelled this credit

cancellationInvoiceNumberstring nullable

Number of the invoice that cancelled this credit

cancelledInvoicetIdinteger nullable

Invoice ID which this credit cancelled

cancelledInvoicetNumberstring nullable

Invoice number which this credit cancelled

customerElectronicAddressstring nullable

Customer electronic address

customerIdinteger nullable

Customer ID

customerNamestring nullable

Customer name

customerNumberstring nullable

Customer number

customerOrderReferencestring nullable

Customer order reference

customerSiretstring nullable

Customer SIRET

customerType'Business' | 'Consumer' | 'Government'
customerVatNumberstring nullable

Customer VAT number

datestring date nullable

Date

footerNotesstring nullable

Footer notes to be print

grossTaxExcludedAmountnumber double

Gross tax excluded amount

headerNotesstring nullable

Header notes to be print

idinteger

Invoice ID

internalIdstring nullable

ID used in your system

internalNotesstring nullable

Internal notes

isCancelledboolean

True when this credit has itself been cancelled by an invoice

isDraftboolean

Indicates whether invoice is draft. Otherwise invoice cannot be modified

isPaidboolean

Indicates whether invoice is paid

liableToVatboolean nullable

Indicates whether the document is liable to VAT

metadataobject 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.

numberstring nullable

Number

overduenumber double

Overdue

pdfUrlstring nullable

Pdf url

publicLinkstring nullable

Public link

region'FR' | 'EU' | 'IE' | 'DOM' | 'Corse' | 'Monaco'
replacedByinteger nullable

ID of the corrected credit that replaces this one

sentAtstring date-time nullable

Sent at

shippingAmountnumber double

Shipping amount

subjectstring nullable

Subject

taxAmountnumber double

Total tax amount

taxExcludedAmountnumber double

Tax excluded amount (discount included)

taxIncludedAmountnumber double

Tax included amount

useTaxIncludedPricesboolean

Indicates whether invoice prices and amount are tax included

vatMode'Auto' | 'Debit' | 'Collection'
vatNotestring nullable

VAT note to print

vatReverseChargeboolean

VAT reverse charge

vendorReferencestring nullable

Vendor reference to be print

Changes

  • 4f7fa64cf9e3Revision changes
    • warning

      removed the optional property /// from the response with the status (media type: text/plain)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: text/json)

    • info

      endpoint deprecated

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property //// to the response with the status (media type: text/plain)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: text/json)

    • info

      added the optional property //// to the response with the status (media type: text/plain)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: text/json)

    • info

      added the optional property //// to the response with the status (media type: text/plain)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: text/json)

    • info

      added the optional property //// to the response with the status (media type: text/plain)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: text/json)

    • info

      added the optional property //// to the response with the status (media type: text/plain)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: text/json)

    • info

      added the optional property //// to the response with the status (media type: text/plain)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: text/json)

    • info

      response property items/lines/items/product/isUnitPriceTaxIncluded deprecated (media type: text/plain)

    • info

      response property items/lines/items/product/isUnitPriceTaxIncluded deprecated (media type: application/json)

    • info

      response property items/lines/items/product/isUnitPriceTaxIncluded deprecated (media type: text/json)

    • info

      response property items/lines/items/product/unitPrice deprecated (media type: text/plain)

    • info

      response property items/lines/items/product/unitPrice deprecated (media type: application/json)

    • info

      response property items/lines/items/product/unitPrice deprecated (media type: text/json)

  • e65392ac5b5fRevision changes
    • info

      added the new optional query request parameter Cancelled

    • info

      added the new optional query request parameter Processed

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)