Create Credit Note

POST {{baseUrl}}/accounting/credit-notes?raw=false

Create Credit Note

Request Params

Request Body

{"total_amount"=>541.25, "number"=>"{{$randomAlphaNumeric}}", "customer"=>{"id"=>"{{primaryCustomerId}}", "display_name"=>"Windsurf Shop", "name"=>"Windsurf Shop", "email"=>"boring@boring.com"}, "company_id"=>"12345", "currency"=>"USD", "currency_rate"=>0.69, "tax_inclusive"=>false, "sub_total"=>27500, "total_tax"=>41.25, "tax_code"=>"1234", "balance"=>27500, "remaining_credit"=>27500, "status"=>"authorised", "reference"=>"123456", "date_issued"=>"2021-05-01T12:00:00.000Z", "date_paid"=>"2021-05-01T12:00:00.000Z", "type"=>"accounts_receivable_credit", "account"=>{"id"=>"123456", "nominal_code"=>"N091", "code"=>"453"}, "line_items"=>[{"row_id"=>"{{invoiceLineItemRowId}}", "code"=>"{{primaryInvoiceItemCode}}", "description"=>"credit - charged in error", "type"=>"sales_item", "tax_amount"=>41.25, "total_amount"=>500, "quantity"=>1, "unit_price"=>500, "unit_of_measure"=>"each", "discount_percentage"=>0, "tax_rate"=>{"code"=>"{{primaryTaxType}}"}, "ledger_account"=>{"code"=>"{{accountsReceivableAccountCode}}"}, "row_version"=>"{{creditNoteRowVersion}}"}], "allocations"=>[{"amount"=>1, "id"=>"{{creditNoteInvoiceId}}"}], "note"=>"Some notes about this credit note", "terms"=>"Some terms about this credit note", "billing_address"=>{"id"=>"123", "type"=>"primary", "string"=>"25 Spring Street, Blackburn, VIC 3130", "name"=>"HQ US", "line1"=>"Main street", "line2"=>"apt #", "line3"=>"Suite #", "line4"=>"delivery instructions", "street_number"=>"25", "city"=>"San Francisco", "state"=>"CA", "postal_code"=>"94104", "country"=>"US", "latitude"=>"40.759211", "longitude"=>"-73.984638", "county"=>"Santa Clara", "contact_name"=>"Elon Musk", "salutation"=>"Mr", "phone_number"=>"111-111-1111", "fax"=>"122-111-1111", "email"=>"elon@musk.com", "website"=>"https://elonmusk.com", "notes"=>"Address notes or delivery instructions.", "row_version"=>"1-12345"}, "shipping_address"=>{"id"=>"123", "type"=>"primary", "string"=>"25 Spring Street, Blackburn, VIC 3130", "name"=>"HQ US", "line1"=>"Main street", "line2"=>"apt #", "line3"=>"Suite #", "line4"=>"delivery instructions", "street_number"=>"25", "city"=>"San Francisco", "state"=>"CA", "postal_code"=>"94104", "country"=>"US", "latitude"=>"40.759211", "longitude"=>"-73.984638", "county"=>"Santa Clara", "contact_name"=>"Elon Musk", "salutation"=>"Mr", "phone_number"=>"111-111-1111", "fax"=>"122-111-1111", "email"=>"elon@musk.com", "website"=>"https://elonmusk.com", "notes"=>"Address notes or delivery instructions.", "row_version"=>"1-12345"}, "tracking_categories"=>[{"id"=>"123456", "name"=>"New York"}, {"id"=>"123456", "name"=>"New York"}], "custom_fields"=>[{"id"=>"2389328923893298", "name"=>"employee_level", "description"=>"Employee Level", "value"=>"Uses Salesforce and Marketo"}, {"id"=>"2389328923893298", "name"=>"employee_level", "description"=>"Employee Level", "value"=>"Uses Salesforce and Marketo"}], "row_version"=>"1-12345"}

HEADERS

RESPONSES

status: Created

{"status_code":200,"status":"OK","service":"xero","resource":"credit-notes","operation":"add","data":{"id":"12345"}}