Create Credit Note

Time	Status	User Agent
Retrieving recent requests…

return_date

date

required

The date on which this credit note was created in the format YYYY-MM-DD

issue_date

date

required

The date on which this credit note was issued in the format YYYY-MM-DD

issue_time

string

The time at which this credit note was issued in the format HH:MM:SS

tax_point_date

date

The actual date when the tax becomes applicable in the format YYYY-MM-DD

document_currency_code

string

required

A code that specifies the default currency in which the credit note is issued

buyer_reference

string

A reference number or code provided by the buyer to track the credit note

trader_invoice_number

string

required

length ≤ 30

An invoice number assigned by the supplier to uniquely identify the credit note in their system

invoice_id

string

required

The DigiTax ID of the invoice that is being credited

accounting_cost

string

Represents the accounting category or cost center assigned to the transaction

payment_terms_note

string

Describes the terms and conditions of payment

invoice_delivery_period

object

Defines the start and end dates for when goods or services were delivered. This helps track multi-day deliveries on a single invoice

payment_means

array of objects

Defines how the invoice will be paid and when payment is due

payment_means

allowance_charge

array of objects

Defines any discounts (allowance) or extra charges (charge)

allowance_charge

dispatch_document_reference

object

An optional identifier of a referenced dispatch advice. Refers to the document used to track the dispatch of goods

receipt_document_reference

object

A reference to a receipt advice associated with a credit note. Links the credit note to a receipt document

originator_document_reference

object

A reference to an originator document associated with a credit note. Identifies the original document that initiated the credit note

contract_document_reference

object

A reference to a contract associated with a credit note. Links the credit note to a contract governing the transaction

additional_document_reference

array of objects

A reference to additional documents associated with an invoice. Used as a general reference field for any related documents

additional_document_reference

due_date

date

The date on which the credit note is due for payment in the format YYYY-MM-DD

notes

string

Additional credit note information that is not contained explicitly in other structures

callback_url

uri

The URL to call when we have new information about the credit note, when the credit note is signed successfully or validation has failed

payment_status

string

enum

The current payment status of the credit note

Allowed:

items

array of objects

required

items*

201Credit note created

defaultError response