Credit Notes
Get a Credit Note by ID
- Explore demo
- Speak to an expert
- Changelog
- Blog
- Account
- Billing
- Collections
- Customer
- Invoices
- Invoices
- Invoice Line Items
- Credit Notes
- Credit Note Line Items
- Notifications
- Product
- Taxes
- Usage
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Taxes
- Usage
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Taxes
- Usage
Latest Live API
Version 2024-05-09
Version 2024-01-01
Credit Notes
Get a Credit Note by ID
Get a Credit Note by ID
GET
/
credit-notes
/
{id}
Authorization
string
*
Authorization
Required
string
Your API credentials. Eg. Basic {credentials}.
Sequence-Version
enum<string>
Sequence-Version
enum<string>
Use this header to select an API version
id
string
*
id
Required
string
Credit Note ID
Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}.
Sequence-Version
enum<string>
Use this header to select an API version
Available options:
2024-05-09 Path Parameters
id
string
requiredCredit Note ID
Response
200 - application/json
id
string
requiredCredit Note ID
sequenceAccountId
string
requiredSequence Account ID
status
enum<string>
requiredCredit Note status
Available options:
DRAFT, FINAL, SENT, VOIDED invoiceId
string
Invoice ID
invoiceNumber
string
Invoice Number
billingScheduleId
string
Subscription ID
currency
enum<string>
requiredCredit Note currency
Available options:
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 issueDate
string
Issue date
billingPeriodStart
string
Billing period start
billingPeriodEnd
string
Billing period end
creditNoteNumber
string
Credit Note number
purchaseOrderNumber
string
Purchase order number
customerId
string
requiredThe ID of the Customer this Credit Note is linked to
customerEmails
string[]
requiredCustomer's email addresses, used for sending the Credit Note if provided
customerLegalCompanyName
string
requiredCustomer's legal company name
customerBillingAddress
object
requiredCustomer's billing address
customerBillingAddress.line1
string
requiredAddress line 1
customerBillingAddress.line2
string
Address line 2
customerBillingAddress.town
string
requiredTown or city
customerBillingAddress.state
enum<string>
State (required for USA only)
Available options:
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, ON, PE, QC, SK customerBillingAddress.postcode
string
requiredPostal code
customerBillingAddress.country
enum<string>
requiredCountry code (ISO 3166-1 alpha-2)
Available options:
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 customerShippingAddress
object
requiredCustomer's billing address
customerShippingAddress.line1
string
requiredAddress line 1
customerShippingAddress.line2
string
Address line 2
customerShippingAddress.town
string
requiredTown or city
customerShippingAddress.state
enum<string>
State (required for USA only)
Available options:
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, ON, PE, QC, SK customerShippingAddress.postcode
string
requiredPostal code
customerShippingAddress.country
enum<string>
requiredCountry code (ISO 3166-1 alpha-2)
Available options:
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 memo
string
Credit Note memo
totalTax
string
requiredTotal tax, in decimal format of the Credit Note's currency
netTotal
string
requiredNet total, in decimal format of the Credit Note's currency
grossTotal
string
requiredGross total, in decimal format of the Invoice's currency
metadata
object[]
requiredMapping of key-value pairs to attach to the Credit Note. These are not interpreted by Sequence; they are present for your use alone.
metadata.key
string
requiredmetadata.value
string
requiredcustomerTaxId
string
Customer's tax ID
linkedServices
object[]
requiredExternal services which are linked to this credit note
linkedServices.externalId
string
requiredThe ID of the related entity in external system
linkedServices.externalService
enum<string>
requiredThe connected service
Available options:
Amazon_Redshift, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero linkedServices.syncTime
string
requiredThe time that this was synced from the connected integration
merchantDetails
object
Merchant details
merchantDetails.address
object
requiredCustomer's billing address
merchantDetails.address.line1
string
requiredAddress line 1
merchantDetails.address.line2
string
Address line 2
merchantDetails.address.town
string
requiredTown or city
merchantDetails.address.state
enum<string>
State (required for USA only)
Available options:
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, ON, PE, QC, SK merchantDetails.address.postcode
string
requiredPostal code
merchantDetails.address.country
enum<string>
requiredCountry code (ISO 3166-1 alpha-2)
Available options:
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 merchantDetails.phoneNumber
string
Merchant's phone number
merchantDetails.email
string
requiredMerchant's email
merchantDetails.taxId
string
Merchant's tax ID
merchantDetails.iban
string
Merchant's IBAN, for receiving payment by bank transfer
merchantDetails.ukAccountDetails
object
Merchant's UK bank account details, for receiving payment by UK bank transfer
merchantDetails.ukAccountDetails.sortCode
string
requiredUK sort code. 6 digits.
merchantDetails.ukAccountDetails.accountNumber
string
requiredUK account number. 8 digits.
merchantDetails.usAchDetails
object
Merchant's US account details, for receiving payment by ACH
merchantDetails.usAchDetails.accountNumber
string
requiredmerchantDetails.usAchDetails.accountName
string
requiredmerchantDetails.usAchDetails.bankName
string
requiredmerchantDetails.usAchDetails.bankRoutingNumber
string
requiredmerchantDetails.usWireDetails
object
Merchant's US account details, for receiving payment by wire transfer
merchantDetails.usWireDetails.accountNumber
string
requiredmerchantDetails.usWireDetails.accountName
string
requiredmerchantDetails.usWireDetails.bankName
string
requiredmerchantDetails.usWireDetails.bankRoutingNumber
string
requiredmerchantDetails.usWireDetails.swiftCode
string
requiredmerchantDetails.usWireDetails.bankAddress
object
requiredCustomer's billing address
merchantDetails.usWireDetails.bankAddress.line1
string
requiredAddress line 1
merchantDetails.usWireDetails.bankAddress.line2
string
Address line 2
merchantDetails.usWireDetails.bankAddress.town
string
requiredTown or city
merchantDetails.usWireDetails.bankAddress.state
enum<string>
State (required for USA only)
Available options:
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, ON, PE, QC, SK merchantDetails.usWireDetails.bankAddress.postcode
string
requiredPostal code
merchantDetails.usWireDetails.bankAddress.country
enum<string>
requiredCountry code (ISO 3166-1 alpha-2)
Available options:
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 merchantDetails.caBankAccountDetails
object
Merchant's Canadian account details, for receiving payment by Canadian bank transfer
merchantDetails.caBankAccountDetails.transitNumber
string
requiredmerchantDetails.caBankAccountDetails.institutionNumber
string
requiredmerchantDetails.caBankAccountDetails.accountNumber
string
requiredmerchantDetails.canadianInternationalDestination
object
Merchant's account details, for receiving payment to a Canadian bank via Wire transfer
merchantDetails.canadianInternationalDestination.legalName
string
requiredmerchantDetails.canadianInternationalDestination.accountNumber
string
requiredmerchantDetails.canadianInternationalDestination.transitNumber
string
requiredmerchantDetails.canadianInternationalDestination.bankName
string
requiredmerchantDetails.canadianInternationalDestination.bankAddress
object
requiredCustomer's billing address
merchantDetails.canadianInternationalDestination.bankAddress.line1
string
requiredAddress line 1
merchantDetails.canadianInternationalDestination.bankAddress.line2
string
Address line 2
merchantDetails.canadianInternationalDestination.bankAddress.town
string
requiredTown or city
merchantDetails.canadianInternationalDestination.bankAddress.state
enum<string>
State (required for USA only)
Available options:
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, ON, PE, QC, SK merchantDetails.canadianInternationalDestination.bankAddress.postcode
string
requiredPostal code
merchantDetails.canadianInternationalDestination.bankAddress.country
enum<string>
requiredCountry code (ISO 3166-1 alpha-2)
Available options:
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 merchantDetails.canadianInternationalDestination.institutionNumber
string
requiredmerchantDetails.canadianInternationalDestination.swiftCode
string
requiredmerchantDetails.canadianInternationalDestination.intermediaryBank
object
merchantDetails.canadianInternationalDestination.intermediaryBank.bankName
string
requiredmerchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress
object
requiredCustomer's billing address
merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.line1
string
requiredAddress line 1
merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.line2
string
Address line 2
merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.town
string
requiredTown or city
merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.state
enum<string>
State (required for USA only)
Available options:
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, ON, PE, QC, SK merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.postcode
string
requiredPostal code
merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.country
enum<string>
requiredCountry code (ISO 3166-1 alpha-2)
Available options:
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 merchantDetails.canadianInternationalDestination.intermediaryBank.swiftCode
string
requiredmerchantDetails.canadianInternationalDestination.intermediaryBank.routingNumber
string
requiredmerchantDetails.australianDestination
object
Merchant's account details, for receiving payment to a Canadian bank via Australian bank transfer
merchantDetails.australianDestination.legalName
string
requiredmerchantDetails.australianDestination.accountNumber
string
requiredmerchantDetails.australianDestination.swiftCode
string
requiredmerchantDetails.australianDestination.bsb
string
requiredmerchantDetails.logoUrl
string
Merchant's logo image URL
merchantDetails.legalCompanyName
string
requiredMerchant's legal company name
merchantDetails.primaryColour
string
Merchant's primary colour (for invoice rendering)
merchantDetails.customFields
object[]
requiredmerchantCustomFields
merchantDetails.customFields.key
string
requiredmerchantDetails.customFields.value
string
requiredmerchantDetails.includeBeneficiaryAddressInPaymentDetails
boolean
requiredInclude beneficiary address in payment details on invoice