Create Invoice Credit Note

An Invoice Credit Note is a financial transaction representing a reduction that can be applied against one or multiple invoices issued to Customers.

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

data

object[]

required

data.invoice_ids

string[] | null

An Array of Invoices associated with the credit note

data.contact_id

string | null

The accounting platform’s unique identifier for the contact associated with this credit note

data.currency_id

string | null

Currency ID of the credit note

data.document_number

string | null

Reference number for the credit note

data.posted_date

string | null

Date on which the credit note was posted

data.memo

string | null

Description of the credit note

data.raw_data

object | null

A JSON containing fields that you can directly pass to the accounting platform.

data.line_items

object[] | null

An array of Credit Note Line Items

data.line_items.account_id

string | null

The ID of the account in the accounting platform

data.line_items.quantity

number | null

The quantity of the item

data.line_items.item_id

string | null

The ID of the item in the accounting platform

data.line_items.tax_id

string | null

The ID of the tax in the accounting platform

data.line_items.unit_amount

number | null

The unit amount of the item

data.line_items.total_discount

number | null

The total discount on the item

data.line_items.description

string | null

The description of the item

data.line_items.tracking_category_ids

string[] | null

The IDs of the tracking categories in the accounting platform

Response

200 - application/json

data

object

required

data.status

enum<string>

required

The status of the job.

Available options:

SUCCESS,

FAILED,

CREATED,

RUNNING

data.upload_job_id

string

required

The ID of the job.

data.data

object[]

required

data.data.job_id

string

required

The ID of the job.

data.data.status

enum<string>

required

The status of the job.

Available options:

success,

failed

data.data.response

object

required

data.data.response.platform_id

string

required

The ID that the accounting platform uses to identify this account

data.data.response.invoice_ids

string[] | null

An Array of Invoices associated with the credit note

data.data.response.contact_id

string | null

The accounting platform’s unique identifier for the contact associated with this credit note

data.data.response.currency_id

string | null

Currency ID of the credit note

data.data.response.document_number

string | null

Reference number for the credit note

data.data.response.posted_date

string | null

Date on which the credit note was posted

data.data.response.memo

string | null

Description of the credit note

data.data.response.status

enum<string>

The status of the credit note.

Available options:

DRAFT,

SUBMITTED,

PARTIALLY_PAID,

PAID,

OVERDUE,

VOID,

UNKNOWN

data.data.response.tax_amount

integer | null

Total tax amount levied on the credit note

data.data.response.total_amount

integer | null

Total amount of the credit note

data.data.response.remaining_credit

integer | null

The balance amount remaining on the credit note

data.data.response.updated_at

string | null

The last ISO 8601 timestamp that the data was updated at

data.data.response.raw_data

object | null

The raw JSON response we get from the accounting platform for that data.

data.data.error

object

The error message if the job failed.

data.data.error.code

string

required

data.data.error.message

string

required

data.data.error.platform_error

string

required

data.data.error.raw_data

object | null

request_timestamp

string

required

The time at which the request was received by the server

response_timestamp

string

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

General

Server Side SDKs

Core API

Unified API

Create Invoice Credit Note

Authorizations

Body

Response