Latest Live API
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Taxes
- Usage
Version 2024-07-30
- Account
- Billing
- Collections
- Customer
- Invoices
- Settings
- Invoices
- Invoice Line Items
- Credit Notes
- Credit Note Line Items
- Notifications
- Product
- Taxes
- Usage
Delete a Credit Note
Delete a Credit Note
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
Credit Note ID
Headers
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
2024-07-30
Path Parameters
Credit Note ID
Response
Credit Note ID
Sequence Account ID
Credit Note status
DRAFT
, FINAL
, SENT
, VOIDED
Credit Note currency
ARS
, AUD
, BRL
, CAD
, CHF
, CNY
, COP
, CZK
, DKK
, EUR
, GBP
, HKD
, ILS
, JPY
, KRW
, MXN
, NOK
, NZD
, PLN
, SEK
, SGD
, THB
, USD
, UYU
, ZAR
The ID of the Customer this Credit Note is linked to
Customer's email addresses, used for sending the Credit Note if provided
Customer's legal company name
Customer's billing address
Address line 1
Town or city
Postal code
Country code (ISO 3166-1 alpha-2)
AD
, AE
, AF
, AG
, AI
, AL
, AM
, AO
, AQ
, AR
, AS
, AT
, AU
, AW
, AX
, AZ
, BA
, BB
, BD
, BE
, BF
, BG
, BH
, BI
, BJ
, BL
, BM
, BN
, BO
, BQ
, BR
, BS
, BT
, BV
, BW
, BY
, BZ
, CA
, CC
, CD
, CF
, CG
, CH
, CI
, CK
, CL
, CM
, CN
, CO
, CR
, CU
, CV
, CW
, CX
, CY
, CZ
, DE
, DJ
, DK
, DM
, DO
, DZ
, EC
, EE
, EG
, EH
, ER
, ES
, ET
, FI
, FJ
, FK
, FM
, FO
, FR
, GA
, GB
, GD
, GE
, GF
, GG
, GH
, GI
, GL
, GM
, GN
, GP
, GQ
, GR
, GS
, GT
, GU
, GW
, GY
, HK
, HM
, HN
, HR
, HT
, HU
, ID
, IE
, IL
, IM
, IN
, IO
, IQ
, IR
, IS
, IT
, JE
, JM
, JO
, JP
, KE
, KG
, KH
, KI
, KM
, KN
, KP
, KR
, KW
, KY
, KZ
, LA
, LB
, LC
, LI
, LK
, LR
, LS
, LT
, LU
, LV
, LY
, MA
, MC
, MD
, ME
, MF
, MG
, MH
, MK
, ML
, MM
, MN
, MO
, MP
, MQ
, MR
, MS
, MT
, MU
, MV
, MW
, MX
, MY
, MZ
, NA
, NC
, NE
, NF
, NG
, NI
, NL
, NO
, NP
, NR
, NU
, NZ
, OM
, PA
, PE
, PF
, PG
, PH
, PK
, PL
, PM
, PN
, PR
, PS
, PT
, PW
, PY
, QA
, RE
, RO
, RS
, RU
, RW
, SA
, SB
, SC
, SD
, SE
, SG
, SH
, SI
, SJ
, SK
, SL
, SM
, SN
, SO
, SR
, SS
, ST
, SV
, SX
, SY
, SZ
, TC
, TD
, TF
, TG
, TH
, TJ
, TK
, TL
, TM
, TN
, TO
, TR
, TT
, TV
, TW
, TZ
, UA
, UG
, UM
, US
, UY
, UZ
, VA
, VC
, VE
, VG
, VI
, VN
, VU
, WF
, WS
, XK
, YE
, YT
, ZA
, ZM
, ZW
Address line 2
State (required for USA only)
AL
, AK
, AZ
, AR
, CA
, CO
, CT
, DC
, DE
, FL
, GA
, HI
, ID
, IL
, IN
, IA
, KS
, KY
, LA
, ME
, MD
, MA
, MI
, MN
, MS
, MO
, MT
, NE
, NV
, NH
, NJ
, NM
, NY
, NC
, ND
, OH
, OK
, OR
, PA
, RI
, SC
, SD
, TN
, TX
, UT
, VT
, VA
, WA
, WV
, WI
, WY
, AB
, BC
, MB
, NB
, NL
, NS
, NT
, NU
, ON
, PE
, QC
, SK
, YT
Customer's billing address
Address line 1
Town or city
Postal code
Country code (ISO 3166-1 alpha-2)
AD
, AE
, AF
, AG
, AI
, AL
, AM
, AO
, AQ
, AR
, AS
, AT
, AU
, AW
, AX
, AZ
, BA
, BB
, BD
, BE
, BF
, BG
, BH
, BI
, BJ
, BL
, BM
, BN
, BO
, BQ
, BR
, BS
, BT
, BV
, BW
, BY
, BZ
, CA
, CC
, CD
, CF
, CG
, CH
, CI
, CK
, CL
, CM
, CN
, CO
, CR
, CU
, CV
, CW
, CX
, CY
, CZ
, DE
, DJ
, DK
, DM
, DO
, DZ
, EC
, EE
, EG
, EH
, ER
, ES
, ET
, FI
, FJ
, FK
, FM
, FO
, FR
, GA
, GB
, GD
, GE
, GF
, GG
, GH
, GI
, GL
, GM
, GN
, GP
, GQ
, GR
, GS
, GT
, GU
, GW
, GY
, HK
, HM
, HN
, HR
, HT
, HU
, ID
, IE
, IL
, IM
, IN
, IO
, IQ
, IR
, IS
, IT
, JE
, JM
, JO
, JP
, KE
, KG
, KH
, KI
, KM
, KN
, KP
, KR
, KW
, KY
, KZ
, LA
, LB
, LC
, LI
, LK
, LR
, LS
, LT
, LU
, LV
, LY
, MA
, MC
, MD
, ME
, MF
, MG
, MH
, MK
, ML
, MM
, MN
, MO
, MP
, MQ
, MR
, MS
, MT
, MU
, MV
, MW
, MX
, MY
, MZ
, NA
, NC
, NE
, NF
, NG
, NI
, NL
, NO
, NP
, NR
, NU
, NZ
, OM
, PA
, PE
, PF
, PG
, PH
, PK
, PL
, PM
, PN
, PR
, PS
, PT
, PW
, PY
, QA
, RE
, RO
, RS
, RU
, RW
, SA
, SB
, SC
, SD
, SE
, SG
, SH
, SI
, SJ
, SK
, SL
, SM
, SN
, SO
, SR
, SS
, ST
, SV
, SX
, SY
, SZ
, TC
, TD
, TF
, TG
, TH
, TJ
, TK
, TL
, TM
, TN
, TO
, TR
, TT
, TV
, TW
, TZ
, UA
, UG
, UM
, US
, UY
, UZ
, VA
, VC
, VE
, VG
, VI
, VN
, VU
, WF
, WS
, XK
, YE
, YT
, ZA
, ZM
, ZW
Address line 2
State (required for USA only)
AL
, AK
, AZ
, AR
, CA
, CO
, CT
, DC
, DE
, FL
, GA
, HI
, ID
, IL
, IN
, IA
, KS
, KY
, LA
, ME
, MD
, MA
, MI
, MN
, MS
, MO
, MT
, NE
, NV
, NH
, NJ
, NM
, NY
, NC
, ND
, OH
, OK
, OR
, PA
, RI
, SC
, SD
, TN
, TX
, UT
, VT
, VA
, WA
, WV
, WI
, WY
, AB
, BC
, MB
, NB
, NL
, NS
, NT
, NU
, ON
, PE
, QC
, SK
, YT
Total tax, in decimal format of the Credit Note's currency
Net total, in decimal format of the Credit Note's currency
Gross total, in decimal format of the Invoice's currency
External services which are linked to this credit note
The ID of the related entity in external system
The connected service
Amazon_Redshift
, Google_BigQuery
, Google_Sheets
, HubSpot
, NetSuite
, QuickBooks_Online
, Salesforce
, Slack
, Snowflake
, Stripe
, Xero
, Avalara
, Anrok
The time that this was synced from the connected integration
External URL
Credit note settings
Whether to generate a cash credit grant when sending this credit note
ENABLED
, DISABLED
Invoice ID
Invoice Number
Subscription ID
Issue date
Billing period start
Billing period end
Credit Note number
Purchase order number
Credit Note memo
Customer's tax ID
Merchant details
Customer's billing address
Address line 1
Town or city
Postal code
Country code (ISO 3166-1 alpha-2)
AD
, AE
, AF
, AG
, AI
, AL
, AM
, AO
, AQ
, AR
, AS
, AT
, AU
, AW
, AX
, AZ
, BA
, BB
, BD
, BE
, BF
, BG
, BH
, BI
, BJ
, BL
, BM
, BN
, BO
, BQ
, BR
, BS
, BT
, BV
, BW
, BY
, BZ
, CA
, CC
, CD
, CF
, CG
, CH
, CI
, CK
, CL
, CM
, CN
, CO
, CR
, CU
, CV
, CW
, CX
, CY
, CZ
, DE
, DJ
, DK
, DM
, DO
, DZ
, EC
, EE
, EG
, EH
, ER
, ES
, ET
, FI
, FJ
, FK
, FM
, FO
, FR
, GA
, GB
, GD
, GE
, GF
, GG
, GH
, GI
, GL
, GM
, GN
, GP
, GQ
, GR
, GS
, GT
, GU
, GW
, GY
, HK
, HM
, HN
, HR
, HT
, HU
, ID
, IE
, IL
, IM
, IN
, IO
, IQ
, IR
, IS
, IT
, JE
, JM
, JO
, JP
, KE
, KG
, KH
, KI
, KM
, KN
, KP
, KR
, KW
, KY
, KZ
, LA
, LB
, LC
, LI
, LK
, LR
, LS
, LT
, LU
, LV
, LY
, MA
, MC
, MD
, ME
, MF
, MG
, MH
, MK
, ML
, MM
, MN
, MO
, MP
, MQ
, MR
, MS
, MT
, MU
, MV
, MW
, MX
, MY
, MZ
, NA
, NC
, NE
, NF
, NG
, NI
, NL
, NO
, NP
, NR
, NU
, NZ
, OM
, PA
, PE
, PF
, PG
, PH
, PK
, PL
, PM
, PN
, PR
, PS
, PT
, PW
, PY
, QA
, RE
, RO
, RS
, RU
, RW
, SA
, SB
, SC
, SD
, SE
, SG
, SH
, SI
, SJ
, SK
, SL
, SM
, SN
, SO
, SR
, SS
, ST
, SV
, SX
, SY
, SZ
, TC
, TD
, TF
, TG
, TH
, TJ
, TK
, TL
, TM
, TN
, TO
, TR
, TT
, TV
, TW
, TZ
, UA
, UG
, UM
, US
, UY
, UZ
, VA
, VC
, VE
, VG
, VI
, VN
, VU
, WF
, WS
, XK
, YE
, YT
, ZA
, ZM
, ZW
Address line 2
State (required for USA only)
AL
, AK
, AZ
, AR
, CA
, CO
, CT
, DC
, DE
, FL
, GA
, HI
, ID
, IL
, IN
, IA
, KS
, KY
, LA
, ME
, MD
, MA
, MI
, MN
, MS
, MO
, MT
, NE
, NV
, NH
, NJ
, NM
, NY
, NC
, ND
, OH
, OK
, OR
, PA
, RI
, SC
, SD
, TN
, TX
, UT
, VT
, VA
, WA
, WV
, WI
, WY
, AB
, BC
, MB
, NB
, NL
, NS
, NT
, NU
, ON
, PE
, QC
, SK
, YT
Merchant's email
Merchant's legal company name
Include beneficiary address in payment details on invoice
Merchant's phone number
Merchant's tax ID
Merchant's IBAN, for receiving payment by bank transfer
Merchant's US account details, for receiving payment by wire transfer
Customer's billing address
Address line 1
Town or city
Postal code
Country code (ISO 3166-1 alpha-2)
AD
, AE
, AF
, AG
, AI
, AL
, AM
, AO
, AQ
, AR
, AS
, AT
, AU
, AW
, AX
, AZ
, BA
, BB
, BD
, BE
, BF
, BG
, BH
, BI
, BJ
, BL
, BM
, BN
, BO
, BQ
, BR
, BS
, BT
, BV
, BW
, BY
, BZ
, CA
, CC
, CD
, CF
, CG
, CH
, CI
, CK
, CL
, CM
, CN
, CO
, CR
, CU
, CV
, CW
, CX
, CY
, CZ
, DE
, DJ
, DK
, DM
, DO
, DZ
, EC
, EE
, EG
, EH
, ER
, ES
, ET
, FI
, FJ
, FK
, FM
, FO
, FR
, GA
, GB
, GD
, GE
, GF
, GG
, GH
, GI
, GL
, GM
, GN
, GP
, GQ
, GR
, GS
, GT
, GU
, GW
, GY
, HK
, HM
, HN
, HR
, HT
, HU
, ID
, IE
, IL
, IM
, IN
, IO
, IQ
, IR
, IS
, IT
, JE
, JM
, JO
, JP
, KE
, KG
, KH
, KI
, KM
, KN
, KP
, KR
, KW
, KY
, KZ
, LA
, LB
, LC
, LI
, LK
, LR
, LS
, LT
, LU
, LV
, LY
, MA
, MC
, MD
, ME
, MF
, MG
, MH
, MK
, ML
, MM
, MN
, MO
, MP
, MQ
, MR
, MS
, MT
, MU
, MV
, MW
, MX
, MY
, MZ
, NA
, NC
, NE
, NF
, NG
, NI
, NL
, NO
, NP
, NR
, NU
, NZ
, OM
, PA
, PE
, PF
, PG
, PH
, PK
, PL
, PM
, PN
, PR
, PS
, PT
, PW
, PY
, QA
, RE
, RO
, RS
, RU
, RW
, SA
, SB
, SC
, SD
, SE
, SG
, SH
, SI
, SJ
, SK
, SL
, SM
, SN
, SO
, SR
, SS
, ST
, SV
, SX
, SY
, SZ
, TC
, TD
, TF
, TG
, TH
, TJ
, TK
, TL
, TM
, TN
, TO
, TR
, TT
, TV
, TW
, TZ
, UA
, UG
, UM
, US
, UY
, UZ
, VA
, VC
, VE
, VG
, VI
, VN
, VU
, WF
, WS
, XK
, YE
, YT
, ZA
, ZM
, ZW
Address line 2
State (required for USA only)
AL
, AK
, AZ
, AR
, CA
, CO
, CT
, DC
, DE
, FL
, GA
, HI
, ID
, IL
, IN
, IA
, KS
, KY
, LA
, ME
, MD
, MA
, MI
, MN
, MS
, MO
, MT
, NE
, NV
, NH
, NJ
, NM
, NY
, NC
, ND
, OH
, OK
, OR
, PA
, RI
, SC
, SD
, TN
, TX
, UT
, VT
, VA
, WA
, WV
, WI
, WY
, AB
, BC
, MB
, NB
, NL
, NS
, NT
, NU
, ON
, PE
, QC
, SK
, YT
Merchant's account details, for receiving payment to a Canadian bank via Wire transfer
Customer's billing address
Address line 1
Town or city
Postal code
Country code (ISO 3166-1 alpha-2)
AD
, AE
, AF
, AG
, AI
, AL
, AM
, AO
, AQ
, AR
, AS
, AT
, AU
, AW
, AX
, AZ
, BA
, BB
, BD
, BE
, BF
, BG
, BH
, BI
, BJ
, BL
, BM
, BN
, BO
, BQ
, BR
, BS
, BT
, BV
, BW
, BY
, BZ
, CA
, CC
, CD
, CF
, CG
, CH
, CI
, CK
, CL
, CM
, CN
, CO
, CR
, CU
, CV
, CW
, CX
, CY
, CZ
, DE
, DJ
, DK
, DM
, DO
, DZ
, EC
, EE
, EG
, EH
, ER
, ES
, ET
, FI
, FJ
, FK
, FM
, FO
, FR
, GA
, GB
, GD
, GE
, GF
, GG
, GH
, GI
, GL
, GM
, GN
, GP
, GQ
, GR
, GS
, GT
, GU
, GW
, GY
, HK
, HM
, HN
, HR
, HT
, HU
, ID
, IE
, IL
, IM
, IN
, IO
, IQ
, IR
, IS
, IT
, JE
, JM
, JO
, JP
, KE
, KG
, KH
, KI
, KM
, KN
, KP
, KR
, KW
, KY
, KZ
, LA
, LB
, LC
, LI
, LK
, LR
, LS
, LT
, LU
, LV
, LY
, MA
, MC
, MD
, ME
, MF
, MG
, MH
, MK
, ML
, MM
, MN
, MO
, MP
, MQ
, MR
, MS
, MT
, MU
, MV
, MW
, MX
, MY
, MZ
, NA
, NC
, NE
, NF
, NG
, NI
, NL
, NO
, NP
, NR
, NU
, NZ
, OM
, PA
, PE
, PF
, PG
, PH
, PK
, PL
, PM
, PN
, PR
, PS
, PT
, PW
, PY
, QA
, RE
, RO
, RS
, RU
, RW
, SA
, SB
, SC
, SD
, SE
, SG
, SH
, SI
, SJ
, SK
, SL
, SM
, SN
, SO
, SR
, SS
, ST
, SV
, SX
, SY
, SZ
, TC
, TD
, TF
, TG
, TH
, TJ
, TK
, TL
, TM
, TN
, TO
, TR
, TT
, TV
, TW
, TZ
, UA
, UG
, UM
, US
, UY
, UZ
, VA
, VC
, VE
, VG
, VI
, VN
, VU
, WF
, WS
, XK
, YE
, YT
, ZA
, ZM
, ZW
Address line 2
State (required for USA only)
AL
, AK
, AZ
, AR
, CA
, CO
, CT
, DC
, DE
, FL
, GA
, HI
, ID
, IL
, IN
, IA
, KS
, KY
, LA
, ME
, MD
, MA
, MI
, MN
, MS
, MO
, MT
, NE
, NV
, NH
, NJ
, NM
, NY
, NC
, ND
, OH
, OK
, OR
, PA
, RI
, SC
, SD
, TN
, TX
, UT
, VT
, VA
, WA
, WV
, WI
, WY
, AB
, BC
, MB
, NB
, NL
, NS
, NT
, NU
, ON
, PE
, QC
, SK
, YT
Customer's billing address
Address line 1
Town or city
Postal code
Country code (ISO 3166-1 alpha-2)
AD
, AE
, AF
, AG
, AI
, AL
, AM
, AO
, AQ
, AR
, AS
, AT
, AU
, AW
, AX
, AZ
, BA
, BB
, BD
, BE
, BF
, BG
, BH
, BI
, BJ
, BL
, BM
, BN
, BO
, BQ
, BR
, BS
, BT
, BV
, BW
, BY
, BZ
, CA
, CC
, CD
, CF
, CG
, CH
, CI
, CK
, CL
, CM
, CN
, CO
, CR
, CU
, CV
, CW
, CX
, CY
, CZ
, DE
, DJ
, DK
, DM
, DO
, DZ
, EC
, EE
, EG
, EH
, ER
, ES
, ET
, FI
, FJ
, FK
, FM
, FO
, FR
, GA
, GB
, GD
, GE
, GF
, GG
, GH
, GI
, GL
, GM
, GN
, GP
, GQ
, GR
, GS
, GT
, GU
, GW
, GY
, HK
, HM
, HN
, HR
, HT
, HU
, ID
, IE
, IL
, IM
, IN
, IO
, IQ
, IR
, IS
, IT
, JE
, JM
, JO
, JP
, KE
, KG
, KH
, KI
, KM
, KN
, KP
, KR
, KW
, KY
, KZ
, LA
, LB
, LC
, LI
, LK
, LR
, LS
, LT
, LU
, LV
, LY
, MA
, MC
, MD
, ME
, MF
, MG
, MH
, MK
, ML
, MM
, MN
, MO
, MP
, MQ
, MR
, MS
, MT
, MU
, MV
, MW
, MX
, MY
, MZ
, NA
, NC
, NE
, NF
, NG
, NI
, NL
, NO
, NP
, NR
, NU
, NZ
, OM
, PA
, PE
, PF
, PG
, PH
, PK
, PL
, PM
, PN
, PR
, PS
, PT
, PW
, PY
, QA
, RE
, RO
, RS
, RU
, RW
, SA
, SB
, SC
, SD
, SE
, SG
, SH
, SI
, SJ
, SK
, SL
, SM
, SN
, SO
, SR
, SS
, ST
, SV
, SX
, SY
, SZ
, TC
, TD
, TF
, TG
, TH
, TJ
, TK
, TL
, TM
, TN
, TO
, TR
, TT
, TV
, TW
, TZ
, UA
, UG
, UM
, US
, UY
, UZ
, VA
, VC
, VE
, VG
, VI
, VN
, VU
, WF
, WS
, XK
, YE
, YT
, ZA
, ZM
, ZW
Address line 2
State (required for USA only)
AL
, AK
, AZ
, AR
, CA
, CO
, CT
, DC
, DE
, FL
, GA
, HI
, ID
, IL
, IN
, IA
, KS
, KY
, LA
, ME
, MD
, MA
, MI
, MN
, MS
, MO
, MT
, NE
, NV
, NH
, NJ
, NM
, NY
, NC
, ND
, OH
, OK
, OR
, PA
, RI
, SC
, SD
, TN
, TX
, UT
, VT
, VA
, WA
, WV
, WI
, WY
, AB
, BC
, MB
, NB
, NL
, NS
, NT
, NU
, ON
, PE
, QC
, SK
, YT
Merchant's account details, for receiving payment to a Canadian bank via Australian bank transfer
Merchant's logo image URL
Merchant's primary colour (for invoice rendering)
Accounting date