CreditNote
object are an accounts payable transaction used when to represent a gift or refund to a customer. A credit note will contain information on the amount of credit owed, the customer, and the account.id
Stringremote_id
Stringtransaction_date
Stringstatus
EnumSUBMITTED
, AUTHORIZED
, PAID
, or -
in cases where there is no clear mapping - the original value passed through.number
Stringcontact
Stringcompany
Stringtotal_amount
Numberremaining_credit
Numberline_items
CreditNoteLineItem[]tracking_categories
Arraycurrency
EnumXUA
, AFN
, AFA
, ALL
, ALK
, DZD
, ADP
, AOA
, AOK
, AON
, AOR
, ARA
, ARS
, ARM
, ARP
, ARL
, AMD
, AWG
, AUD
, ATS
, AZN
, AZM
, BSD
, BHD
, BDT
, BBD
, BYN
, BYB
, BYR
, BEF
, BEC
, BEL
, BZD
, BMD
, BTN
, BOB
, BOL
, BOV
, BOP
, BAM
, BAD
, BAN
, BWP
, BRC
, BRZ
, BRE
, BRR
, BRN
, BRB
, BRL
, GBP
, BND
, BGL
, BGN
, BGO
, BGM
, BUK
, BIF
, XPF
, KHR
, CAD
, CVE
, KYD
, XAF
, CLE
, CLP
, CLF
, CNX
, CNY
, CNH
, COP
, COU
, KMF
, CDF
, CRC
, HRD
, HRK
, CUC
, CUP
, CYP
, CZK
, CSK
, DKK
, DJF
, DOP
, NLG
, XCD
, DDM
, ECS
, ECV
, EGP
, GQE
, ERN
, EEK
, ETB
, EUR
, XBA
, XEU
, XBB
, XBC
, XBD
, FKP
, FJD
, FIM
, FRF
, XFO
, XFU
, GMD
, GEK
, GEL
, DEM
, GHS
, GHC
, GIP
, XAU
, GRD
, GTQ
, GWP
, GNF
, GNS
, GYD
, HTG
, HNL
, HKD
, HUF
, IMP
, ISK
, ISJ
, INR
, IDR
, IRR
, IQD
, IEP
, ILS
, ILP
, ILR
, ITL
, JMD
, JPY
, JOD
, KZT
, KES
, KWD
, KGS
, LAK
, LVL
, LVR
, LBP
, LSL
, LRD
, LYD
, LTL
, LTT
, LUL
, LUC
, LUF
, MOP
, MKD
, MKN
, MGA
, MGF
, MWK
, MYR
, MVR
, MVP
, MLF
, MTL
, MTP
, MRU
, MRO
, MUR
, MXV
, MXN
, MXP
, MDC
, MDL
, MCF
, MNT
, MAD
, MAF
, MZE
, MZN
, MZM
, MMK
, NAD
, NPR
, ANG
, TWD
, NZD
, NIO
, NIC
, NGN
, KPW
, NOK
, OMR
, PKR
, XPD
, PAB
, PGK
, PYG
, PEI
, PEN
, PES
, PHP
, XPT
, PLN
, PLZ
, PTE
, GWE
, QAR
, XRE
, RHD
, RON
, ROL
, RUB
, RUR
, RWF
, SVC
, WST
, SAR
, RSD
, CSD
, SCR
, SLL
, XAG
, SGD
, SKK
, SIT
, SBD
, SOS
, ZAR
, ZAL
, KRH
, KRW
, KRO
, SSP
, SUR
, ESP
, ESA
, ESB
, XDR
, LKR
, SHP
, XSU
, SDD
, SDG
, SDP
, SRD
, SRG
, SZL
, SEK
, CHF
, SYP
, STN
, STD
, TVD
, TJR
, TJS
, TZS
, XTS
, THB
, XXX
, TPE
, TOP
, TTD
, TND
, TRY
, TRL
, TMT
, TMM
, USD
, USN
, USS
, UGX
, UGS
, UAH
, UAK
, AED
, UYW
, UYU
, UYP
, UYI
, UZS
, VUV
, VES
, VEB
, VEF
, VND
, VNN
, CHE
, CHW
, XOF
, YDD
, YER
, YUN
, YUD
, YUM
, YUR
, ZWN
, ZRN
, ZRZ
, ZMW
, ZMK
, ZWD
, ZWR
, ZWL
, or -
in cases where there is no clear mapping - the original value passed through.remote_created_at
Stringremote_updated_at
Stringpayments
ArrayPayment
object IDsremote_was_deleted
Booleanfield_mappings
Objectmodified_at
Stringremote_data
RemoteData[]{"id": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","remote_id": "123877","transaction_date": "2020-03-31T00:00:00Z","status": "PAID","number": "CN-29","contact": "c6c7b870-bb4d-489a-921e-2f0ee4192ff9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remaining_credit": 20,"line_items": [{"item": "0e3fd929-436c-4fd4-a48b-0c61f68d6178","name": "Basic Monthly","description": "prorated amount for items","quantity": 1,"memo": "privNote","unit_price": "5.0","tax_rate": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","total_line_amount": "5.0","tracking_category": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","tracking_categories": ["8d9fd929-436c-4fd4-a48b-0c61f68d6178","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"account": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_id": "121222"}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"currency": "USD","remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"remote_was_deleted": true,Show advanced fields}
Returns a list of CreditNote
objects.
Authorization
StringX-Account-Token
Stringcompany_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
Stringtransaction_date_after
Stringtransaction_date_before
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","remote_id": "123877","transaction_date": "2020-03-31T00:00:00Z","status": "PAID","number": "CN-29","contact": "c6c7b870-bb4d-489a-921e-2f0ee4192ff9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remaining_credit": 20,"line_items": [{"item": "0e3fd929-436c-4fd4-a48b-0c61f68d6178","name": "Basic Monthly","description": "prorated amount for items","quantity": 1,"memo": "privNote","unit_price": "5.0","tax_rate": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","total_line_amount": "5.0","tracking_category": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","tracking_categories": ["8d9fd929-436c-4fd4-a48b-0c61f68d6178","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"account": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_id": "121222"}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"currency": "USD","remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"remote_was_deleted": true,Show advanced fields}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Enumremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringcompany
stringremote_id
stringcompany
Stringcontact
Stringcurrency
Enumnumber
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertracking_categories
Arraytransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringquantity
stringunit_price
stringtotal_line_amount
stringaccount
stringremote_id
stringcompany
Stringcontact
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringtracking_category
stringtracking_categories
arrayaccount
stringremote_id
stringcontact
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertracking_categories
Arraytransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Enumremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringcompany
stringremote_id
stringcompany
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringtracking_category
stringtracking_categories
arrayaccount
stringremote_id
stringcontact
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringaccount
stringremote_id
stringcompany
Stringcontact
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
StringReturns a CreditNote
object with the given id
.
Authorization
StringX-Account-Token
Stringexpand
Stringid
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"id": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","remote_id": "123877","transaction_date": "2020-03-31T00:00:00Z","status": "PAID","number": "CN-29","contact": "c6c7b870-bb4d-489a-921e-2f0ee4192ff9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount": 50,"remaining_credit": 20,"line_items": [{"item": "0e3fd929-436c-4fd4-a48b-0c61f68d6178","name": "Basic Monthly","description": "prorated amount for items","quantity": 1,"memo": "privNote","unit_price": "5.0","tax_rate": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","total_line_amount": "5.0","tracking_category": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","tracking_categories": ["8d9fd929-436c-4fd4-a48b-0c61f68d6178","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"account": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_id": "121222"}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"currency": "USD","remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"remote_was_deleted": true,Show advanced fields}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Enumremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringcompany
stringremote_id
stringcompany
Stringcontact
Stringcurrency
Enumnumber
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertracking_categories
Arraytransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringquantity
stringunit_price
stringtotal_line_amount
stringaccount
stringremote_id
stringcompany
Stringcontact
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringtracking_category
stringtracking_categories
arrayaccount
stringremote_id
stringcontact
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertracking_categories
Arraytransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Enumremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringtotal_line_amount
stringtracking_categories
arrayaccount
stringcompany
stringremote_id
stringcompany
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringtracking_category
stringtracking_categories
arrayaccount
stringremote_id
stringcontact
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
CreditNoteLineItem[]item
stringdescription
stringquantity
stringunit_price
stringtotal_line_amount
stringaccount
stringremote_id
stringcompany
Stringcontact
Stringcurrency
Enumnumber
Stringremaining_credit
Numberremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Numbertransaction_date
String