Create a credit note against an invoice never submitted to FIRS/NRS

post

https://api.digitax.tech/ng/v1/external-credit-notes

Raises a credit note against an invoice that was issued before e-invoicing began and was never submitted to FIRS/NRS - so it has no IRN and no DigiTax invoice ID. Unlike the other credit note endpoints, party and item details are supplied inline rather than referencing an existing invoice_id

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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

original_invoice

object

required

trader_invoice_number

string

length ≤ 30

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

party_tin

string

The tax identification number or company incorporation number(if the party does not yet have a TIN) of the buyer of the goods or services

party_name

string

The taxpayer name of the buyer of the goods or services. It must be provided for credit notes that have the party_tin provided

party_email

string

The email address of the buyer of the goods or services. If it is not provided and the party_tin is provided, we will use [email protected] as the party's email address

party_address

object

The address of the buyer of the goods or services. If not provided and the party_tin is provided, we will use a default address

payee_party_tin

string

The tax identification number or company incorporation number(if the party does not yet have a TIN) of the party to whom the payment goes to; if it goes to someone else

payee_party_name

string

The taxpayer name of the party to whom the payment goes to; if it goes to someone else. It must be provided for credit notes that have the payee_party_tin provided

payee_party_email

string

The email address of the party to whom the payment goes to; if it goes to someone else. If it is not provided and the payee_party_tin is provided, we will use [email protected] as the party's email address

payee_party_address

object

The address of the party to whom the payment goes to; if it goes to someone else. If not provided and the payee_party_tin is provided, we will use a default address

bill_party_tin

string

The tax identification number or company incorporation number(if the party does not yet have a TIN) of the party to whom the payment goes to; if it goes to someone else

bill_party_name

string

The taxpayer name of the party to whom the payment goes to; if it goes to someone else. It must be provided for credit notes that have the bill_party_tin provided

bill_party_email

string

The email address of the party to whom the payment goes to; if it goes to someone else. If it is not provided and the bill_party_tin is provided, we will use [email protected] as the party's email address

bill_party_address

object

The address of the party to whom the payment goes to; if it goes to someone else. If not provided and the bill_party_tin is provided, we will use a default address

ship_party_tin

string

The tax identification number or company incorporation number(if the party does not yet have a TIN) of the party to whom the payment goes to; if it goes to someone else

ship_party_name

string

The taxpayer name of the party to whom the payment goes to; if it goes to someone else. It must be provided for credit notes that have the ship_party_tin provided

ship_party_email

string

The email address of the party to whom the payment goes to; if it goes to someone else. If it is not provided and the ship_party_tin is provided, we will use [email protected] as the party's email address

ship_party_address

object

The address of the party to whom the payment goes to; if it goes to someone else. If not provided and the ship_party_tin is provided, we will use a default address

tax_representative_party_tin

string

The tax identification number or company incorporation number(if the party does not yet have a TIN) of the tax agent handling invoicing and compliance for the business if there is one

tax_representative_party_name

string

The taxpayer name of the tax agent handling invoicing and compliance for the business. It must be provided for credit notes that have the tax_representative_party_tin provided

tax_representative_party_email

string

The email address of the tax agent handling invoicing and compliance for the business. If it is not provided and the tax_representative_party_tin is provided, we will use [email protected] as the party's email address

tax_representative_party_address

object

The address of the tax agent handling invoicing and compliance for the business. If not provided and the tax_representative_party_tin is provided, we will use a default address

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 it is signed successfully or validation has failed

invoice_kind

string

enum

required

Specifies the kind of credit note that was sent. It can either be Business to Business (B2B), Business to Consumer (B2C) or Business to Government (B2G)

Allowed:

payment_status

string

enum

The payment status of the credit note at creation. PARTIAL and REJECTED are not accepted here - use the payment status endpoint to move the credit note to either of those once it has been signed

Allowed:

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

additional_document_reference

array of objects

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

additional_document_reference

items

array of objects

required

A list that captures details about each good or service being credited

items*

Responses

201External credit note created

defaultError response