Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Credit Notes

Retrieve credit note

Endpoint for retrieving a single credit note.

get/credit-notes/{id}/

Path parameters

idstring required

Response

amountnumber double required

The total amount of the credit note, including taxes.

attachmentsstring[]

Any files or documents attached to this credit note.

balancenumber double required

The remaining balance of the credit note.

branchstring nullable

The branch associated with this credit note.

contactstring required

The contact associated with this credit note.

created_tsstring date-time required

The timestamp in UTC when the credit note was created

credit_note_datestring date required

The date when the credit note was issued.

credit_note_numberstring required

The unique number assigned to this credit note.

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' required
  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • ...

Full information for CurrencyEnum

custom_fieldsobject

A mapping of custom field IDs to their values.

discount_cost_centerstring

The cost center to which the discount is applied, if applicable.

exchange_ratenumber double nullable

The exchange rate to the organization base currency at the time of the document.

external_idstring

External identifier for the credit note.

idstring required

The unique identifier of the credit note.

language'ar' | 'en'
  • ar - Arabic
  • en - English

Full information for LanguageEnum

legacy_idstring required

[Deprecated] The legacy identifier of the credit note.

modified_tsstring date-time required

The timestamp in UTC when the credit note was last modified

notesstring

Any additional notes or comments for this credit note.

place_of_supplystring

Only required if your organization is in the UAE: one of ABU_DHABI, AJMAN, DUBAI, FUJAIRAH, RAS_AL_KHAIMAH, SHARJAH, UMM_AL_QUWAIN or OUTSIDE_UAE

projectstring nullable

The project associated with this credit note, if applicable.

referencestring

An optional reference number or code for this credit note.

status'DRAFT' | 'SENT' | 'FINALIZED'
  • DRAFT - DRAFT
  • SENT - SENT
  • FINALIZED - FINALIZED

Full information for Status730Enum

tax_amountnumber double required

The total tax amount applied to this credit note.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'
  • TAX_INCLUSIVE - inc. tax
  • TAX_EXCLUSIVE - exc. tax

Full information for TaxAmountTypeEnum

warehousestring nullable

The warehouse associated with this credit note, if applicable.