Create Self-Billed Credit Note

post

https://staging.api.digitax.tech/ae/v1/self-billed-credit-notes

Creates a new PINT-AE compliant self-billed credit note

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

trader_invoice_number

string

An invoice number assigned by the buyer to uniquely identify the self-billed credit note in their system

credit_note_reason_code

string

required

The coded reason for the self-billed credit note. See GET /resources/credit-reasons for available values.

credit_note_reason

string

required

The textual reason for the self-billed credit note

original_invoice_id

string

The DigiTax ID of the original self-billed invoice this credit note relates to

invoice_type_code

string

required

The UN/CEFACT document type code. If the credit note references an original invoice, the value should correspond to the original invoice type code (e.g. "261" for a self billed credit note referencing a "389" self billed invoice). See GET /resources/invoice-types for available values.

issue_date

date

required

The date on which the self-billed credit note was issued (YYYY-MM-DD). Must not be in the future and must not be more than 30 days in the past.

issue_time

string

The credit note issue time (HH:MM:SS)

due_date

date

The payment due date (YYYY-MM-DD)

document_currency_code

string

required

The currency code (ISO 4217). See GET /resources/currencies for available values.

tax_currency_exchange_rate

double

The exchange rate between document and tax currencies. Required and must be > 0 when document_currency_code is not AED. When document_currency_code is AED, must be 1 or omitted. Maximum 6 decimal places.

supplier_id

string

required

The DigiTax supplier ID of the supplier from whom the buyer is self-billing

payee_party_id

string

The DigiTax party ID of the payee (if different from supplier)

tax_representative_party_id

string

The DigiTax party ID of the seller's tax representative

buyer_reference

string

An identifier assigned by the buyer used for internal routing purposes

accounting_cost

string

A textual value that specifies where to book the relevant data into the buyer's financial accounts

note

string

A free-text note on the self-billed credit note

invoice_period

object

The period to which the invoice relates

order_reference

object

A reference to a purchase and/or sales order

despatch_document_reference

object

A reference to another document (e.g. despatch advice, receipt advice, contract)

receipt_document_reference

object

A reference to another document (e.g. despatch advice, receipt advice, contract)

originator_document_reference

object

A reference to another document (e.g. despatch advice, receipt advice, contract)

contract_document_reference

object

A reference to another document (e.g. despatch advice, receipt advice, contract)

additional_documents

array of objects

Additional supporting document references

additional_documents

delivery

object

Delivery information for the items in the invoice. When transaction_types includes EXPORTS, delivery is required and delivery_address.country_code must not be AE.

payment_terms_note

string

Textual payment terms

allowance_charges

array of objects

Invoice-level allowances and charges

allowance_charges

payments

array of objects

Payment means for this self-billed credit note

payments

items

array of objects

required

The self-billed credit note line items

items*

prepaid_amount

double

The amount already paid

payable_rounding_amount

double

The rounding amount

transaction_types

array of strings

The list of applicable PINT-AE transaction types

transaction_types

beneficiary_trn

string

The TRN of the beneficiary for Free Trade Zone supplies. Required when transaction_types includes FREE_TRADE_ZONE.

principle_trn

string

The TRN of the principal for Disclosed Agent billing. Required when transaction_types includes AGENT_BILLING. Must differ from the business's own TRN.

Responses

201Created self-billed credit note

defaultError response