FOfonoa
Transactions

Credit a transaction

Credit a previously submitted transaction.

Credit note must reference the original debit transaction.

Use /credit endpoint to credit the whole transaction.

post/v1/transactions/credit

Request

  • The document declares no server URL.
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Request body

country_codestring required

ISO 3166-1 alpha-2 uppercase country code the transaction is taking place in.

Validations:

  • Country code must be uppercase ISO 3166-1 alpha-2.
  • Required property
country_subdivision_codestring

ISO 3166-2 uppercase code of the principal country subdivision (province, state, region) the transaction is taking place in.

Validations:

  • Values allowed are (letter case matters): AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT
  • Country subdivision code is only supported for Canada.
issue_datestring

The date when the transaction was issued by an external application.

Validations:

  • Must be an RFC3339 format date
notestring

A text note attached to a transaction. Notes are HTML enabled and will be displayed on the visual document.

Validations:

  • Maximum length: 3000
reference_transaction_idstring required

The external transaction identifier of the original transaction the credit is referencing. e.g., MY_ORIGINAL_IDENTIFIER_0001

Validations:

  • Maximum length: 150
  • Required property
seriesstring

A pool of transaction numbers issued by tax authorities to pick the transaction number from.

The transaction shall be assigned one of the numbers from this pool when reporting it to the tax authorities.

Usually series can be opened and closed at any time and there can be multiple open series at the same time.

e.g., 2022_01

Validations:

  • Maximum length: 20
tax_authority_id_1string

Main transaction identifier returned by or to be provided to the tax authorities. e.g., JIR in Croatia.

Validations:

  • This field is only supported in specific use cases, refer to country-specific integration guides in the Fonoa dashboard.
tax_authority_id_2string

Secondary transaction identifier returned by or to be provided to the tax authorities. e.g., ZKI in Croatia.

Validations:

  • This field is only supported in specific use cases, refer to country-specific integration guides in the Fonoa dashboard.
transaction_datestring required

RFC3339 datetime string representing the point in time when transaction is executed.

Validations:

  • Required property
  • Must be an RFC3339 format date
transaction_idstring required

External transaction identifier provided by the customer. e.g., MY_CREDIT_IDENTIFIER_0001

Validations:

  • Maximum length: 150
  • Required property
transaction_numberstring

Unique and usually sequential identifier of a transaction displayed on the document and reported to tax authorities. e.g., invoice number for debit scenario or credit note number for credit scenario. e.g., IE00000001

Validations:

  • Maximum length: 50

Example request

{
  "note": "This is my HTML <e>enabled</e> note."
}

Response

Accepted - transaction was successfully submitted for processing.

messagestring

Information about the failure reason in case the request was unsuccessful.

operation_idstring

Auto-generated unique identifier of a transaction operation returned upon async operation request.

transaction_idstring

The unique external transaction identifier provided with the initial request.

Changes

No recorded changes to this operation across all 1 revision of this API.