Get Credit Note
GET {{baseUrl}}/accounting/credit-notes/:id?raw=false
Get Credit Note
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
raw | boolean | Include raw response. Mostly used for debugging purposes | |
fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: fields=name,email,addresses.city<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | |
cursor | null | ||
pass_through[search] | null |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-apideck-consumer-id | string | (Required) ID of the consumer which you want to get or push data from | |
x-apideck-app-id | string | (Required) The ID of your Unify application | |
x-apideck-service-id | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | |
Accept | string |
RESPONSES
status: OK
{"status_code":200,"status":"OK","service":"xero","resource":"credit-notes","operation":"one","data":{"id":"123456","total_amount":49.99,"number":"OIT00546","customer":{"id":"12345","display_id":"CUST00101","display_name":"Windsurf Shop","name":"Windsurf Shop","company_name":"The boring company","email":"boring@boring.com"},"company_id":"12345","currency":"USD","currency_rate":0.69,"tax_inclusive":true,"sub_total":27500,"total_tax":2500,"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","name":"Bank account","nominal_code":"N091","code":"453"},"line_items":[{"id":"12345","row_id":"12345","code":"120-C","line_number":1,"description":"Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.","type":"sales_item","tax_amount":27500,"total_amount":27500,"quantity":1,"unit_price":27500.5,"unit_of_measure":"pc.","discount_percentage":0.01,"discount_amount":19.99,"location_id":"1234","department_id":"1234","item":{"id":"12344","code":"120-C","name":"Model Y"},"tax_rate":{"id":"123456","code":"N-T","name":"GST on Purchases","rate":10},"tracking_categories":[{"id":"123456","name":"New York"},{"id":"123456","name":"New York"}],"ledger_account":{"id":"123456","name":"Bank account","nominal_code":"N091","code":"453"},"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","updated_by":"12345","created_by":"12345","created_at":"2020-09-30T07:43:32.000Z","updated_at":"2020-09-30T07:43:32.000Z"},{"id":"12345","row_id":"12345","code":"120-C","line_number":1,"description":"Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.","type":"sales_item","tax_amount":27500,"total_amount":27500,"quantity":1,"unit_price":27500.5,"unit_of_measure":"pc.","discount_percentage":0.01,"discount_amount":19.99,"location_id":"1234","department_id":"1234","item":{"id":"12344","code":"120-C","name":"Model Y"},"tax_rate":{"id":"123456","code":"N-T","name":"GST on Purchases","rate":10},"tracking_categories":[{"id":"123456","name":"New York"},{"id":"123456","name":"New York"}],"ledger_account":{"id":"123456","name":"Bank account","nominal_code":"N091","code":"453"},"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","updated_by":"12345","created_by":"12345","created_at":"2020-09-30T07:43:32.000Z","updated_at":"2020-09-30T07:43:32.000Z"}],"allocations":[{"id":"123456","type":"expense","code":"N091","amount":49.99,"allocation_id":"123456"},{"id":"123456","type":"other","code":"N091","amount":49.99,"allocation_id":"123456"}],"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_mappings":{},"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","updated_by":"12345","created_by":"12345","updated_at":"2020-09-30T07:43:32.000Z","created_at":"2020-09-30T07:43:32.000Z"}}