---
title: "Get a transaction"
method: GET
path: "/v1/transactions/{operation_id}"
---

# Get a transaction

`GET /v1/transactions/{operation_id}`

Get a previously submitted transaction referenced by Fonoa ID. There are no guarantees that the transaction will be available before the transaction_completed webhook is sent.

## Path parameters

- `operation_id` string, required

## Query parameters

- `decimal_amounts` boolean

## Response `200`

Ok - the transaction was successfully retrieved.

- TransactionResponse
  - `activity_code` string — Activity code is a standard classification of productive economic activities. It can be used to represent EAC (Economic Activity code), a standard classification governed by ISIC and NACE (https://joinup.ec.europa.eu/collection/eu-semantic-interoperability-catalogue/solution/statistical-classification-economic-activities-european-community/about), or other similar concepts. e.g., 10.32 is Manufacture of fruit and vegetable juice
  - `additional_compliance_data` AdditionalComplianceDataResponse
    - `fiscal_device` FiscalDeviceResponse
      - `global_document_id` string — Global document identifier across all fiscal periods.
      - `period_document_id` string — Document identifier within the fiscal period.
      - `period_id` string — Identifier of the fiscal period.
    - `verification_code` string — Compliance code used to verify the authenticity of the reported document.
  - `attachments` TransactionAttachmentResponse[] — A list of transaction attachments. e.g., PDF invoice.
    - `expiration_date` string — RFC3339 datetime string representing when the resource_url expires.
    - `kind` string — Attachment kind. One of the following values: VISUAL, REPORT, ACK
    - `resource_id` string — Attachment identifier. Present in the resource_url.
    - `resource_url` string — Attachment download URL. Fonoa offers no guarantees that the URL won't be changed. It is suggested to download the document immediatelly as URL may expire. e.g., https://api.fonoa.com/invoicing/v1/invoices/4983240cf1d84f5c91e078d0a41c6001/pdf
    - `type` string — Attachment type. One of the following values: PDF, HTML, XML, JSON
  - `backfill` boolean — Indicates whether the transaction is a backfill.
  - `business_location` BusinessLocationResponse
    - `name` string — The name of the business location.
  - `business_model` string — Business model of the transaction. Can be either B2B or B2C depending on the customer type.
  - `country_code` string — ISO 3166-1 alpha-2 uppercase country code the transaction is taking place in.
  - `country_subdivision_code` string — ISO 3166-2 uppercase code of the principal country subdivision (province, state, region) the transaction is taking place in.
  - `currency_code` string — Primary currency code of the transaction represented as ISO 4217 3 letter uppercase currency code e.g. `USD`.
  - `customer` TransactionNonOnboardedEntityResponse
    - `address` TransactionEntityAddressResponse
      - `address_line_1` string — Street name and number of the company.
      - `address_line_2` string
      - `canton` string
      - `city` string — The city where the legal entity that is being onboarded is registered.
      - `city_code` string
      - `country_code` string — ISO 3166-1 alpha-2 uppercase country code of the country where entity is registered.
      - `district` string
      - `neighbourhood` string
      - `number` string
      - `postal_code` string — Postal code of the city where the company is registered.
      - `prefix` string
      - `province` string
      - `region` string
      - `state` string
      - `suffix` string
    - `contact_details` TransactionEntityContactDetailsResponse
      - `certified_email` string — The certified email of the entity.
      - `email` string — Email contact of the entity.
      - `phone_number` string — The phone number contact of the entity.
      - `website` string — Website address of the entity.
    - `country_code` string — Specifies the country of the entity. Country code is an ISO 3166-1 two-letter format (e.g, us, de, fr, etc.)
    - `entity_number` string — This is a company registration number if entity is a business or personal identifier if entity is an individual. e.g., 011589551
    - `entity_number_type` string — This is company or individual number type. e.g., 93 (Argentina - birth certificate)
    - `establishment_date` string — The date when the company was established or business activity started. Establishment Date should be in ISO8601 standard.
    - `external_id` string — External resource identifier provided by the customer. e.g., MY_EXTERNAL_ID_001
    - `id` string — Fonoa id representing a resource within the system. e.g., a7cc64422fc247069aa64d4fe8b387c5
    - `language_code` string — Specifies the language of the entity. Language code is an ISO 639-1 two-letter format (e.g, en, de, fr, etc.)
    - `legal_name` string — Full legal name of the company (or the individual). e.g., Acme LLC; John Fitzgerald Kennedy
    - `logo` string — url of the logo to be used in invoice documents for this company
    - `representative_email` string — Email address of the representative of the entity.
    - `representative_name` string — Full name of the representative of the entity.
    - `role` string — Role of the entity in the transaction (e.g., RECIPIENT). Used to distinguish different types of secondary entities.
    - `tax_information` TransactionEntityTaxInformationResponse
      - `accounting_basis` string — The supplier's method of tracking income and expenses in accounting
      - `activity_code` string — Activity code representing business activity of the entity.
      - `additional_tax_numbers` TransactionEntityTaxNumberCountrySpecific[] — Additional tax numbers used by the business entity when operating abroad.
        - `business_model` string[] — Applicable transaction business models (optional).
        - `country_code` string — Country where provided tax number should be used.
        - `country_subdivision_code` string — Country subdivision code where tax number should be used (optional).
        - `tax_number` string — Tax number.
        - `type` string — The tax number type (optional).
      - `authorization_code` string — Authorization code issued by TA.
      - `billing_file_number` string — Unique identifier assigned to individuals or entities to enable accurate and efficient invoicing processes.
      - `device_id` string — Device ID issued by tax authority.
      - `distribution_address` string — Value to be used by the Tax Authority to forward the reported invoice to the customer/buyer
      - `document_type` string — Type of document number (e.g. passport or national_id) provided in tax_number, if applicable.
      - `point_of_sale` string — Virtual point of sale number used by company when issuing invoices.
      - `regime` string — Tax regime the entity is registered with. e.g., VAT
      - `tax_code` string — Tax code that complements tax number.
      - `tax_number` string — Tax number of tax registered entity. e.g., 69061864-2-99
    - `template_configuration` TransactionEntityTemplateConfiguration
      - `color` string — The hexadecimal color value used for the invoice - example: 293d62
      - `font` string — The font used for the invoice. Some of the supported fonts include Abhaya Libre, Helvetica World, Hind, Lora, Open Sans, Rubik, among others. If you wish to have your own font please reach out to Fonoa support.
      - `logo_placement` string — Where on the invoice your logo will be placed - left or right
    - `trade_name` string — The name the company (or the individual) use to do business. e.g., Acme; John F Kennedy
    - `type` string — Entity type defining the type of the transaction (B2B or B2C).
  - `data_source` string — The source of the transaction data: API, CSV, TA, SUPPLIER or DIGITAL_EXCHANGE.
  - `decimal_amounts` boolean — A flag to be used in a migration phase. It signals in which format amounts should be parsed. If true amounts are parsed as decimals, if false amounts are parsed as an integer representing the minor currency unit.
  - `direction` string — Document representing a transaction can be sent or received. Allows businesses to report both inbound and outbound transactions for VAT deduction purposes. Default: `SENT`.
  - `document_generated_at` string — RFC3339 timestamp when the transaction document was generated.
  - `document_references` DocumentReferenceResponse[] — List of document references related to the transaction, such as transport documents, customs documents, or other relevant references.
    - `identifier` string — Buyer’s document reference identifier (e.g., PO number) identifying the document this invoice relates to.
    - `issue_date` string — Date when the referenced document was issued. Validations: - Must be an RFC3339 format date
    - `reason` string — Reason for the document reference.
    - `tender_reference` string — Identifier of the procurement procedure or tender associated with the referenced document.
    - `type` string — Type of the document reference.
  - `end_date` string — RFC3339 datetime string representing an ending point in time.
  - `errors` TransactionErrorResponse[] — List of errors while processing the transaction.
    - `code` string — Error code of the issue. e.g., field_not_valid
    - `doc_link` string — The link for the error documentation. Follow it to gather more details about the error
    - `field` string — Field from the input request that caused the error, in case of validation errors. e.g. transaction_date
    - `message` string — Error message of the issue. e.g., Date must be in RFC3339 format.
    - `type` string — Error type of the issue. e.g., warning, validation, general, tax_authority
  - `frequency` string — Describes the frequency of reporting invoices to tax authority, used with SUMMARY invoice types.
  - `issue_date` string — RFC3339 datetime string representing the point in time when transaction is issued.
  - `issuer` TransactionNonOnboardedEntityResponse
    - `address` TransactionEntityAddressResponse
      - `address_line_1` string — Street name and number of the company.
      - `address_line_2` string
      - `canton` string
      - `city` string — The city where the legal entity that is being onboarded is registered.
      - `city_code` string
      - `country_code` string — ISO 3166-1 alpha-2 uppercase country code of the country where entity is registered.
      - `district` string
      - `neighbourhood` string
      - `number` string
      - `postal_code` string — Postal code of the city where the company is registered.
      - `prefix` string
      - `province` string
      - `region` string
      - `state` string
      - `suffix` string
    - `contact_details` TransactionEntityContactDetailsResponse
      - `certified_email` string — The certified email of the entity.
      - `email` string — Email contact of the entity.
      - `phone_number` string — The phone number contact of the entity.
      - `website` string — Website address of the entity.
    - `country_code` string — Specifies the country of the entity. Country code is an ISO 3166-1 two-letter format (e.g, us, de, fr, etc.)
    - `entity_number` string — This is a company registration number if entity is a business or personal identifier if entity is an individual. e.g., 011589551
    - `entity_number_type` string — This is company or individual number type. e.g., 93 (Argentina - birth certificate)
    - `establishment_date` string — The date when the company was established or business activity started. Establishment Date should be in ISO8601 standard.
    - `external_id` string — External resource identifier provided by the customer. e.g., MY_EXTERNAL_ID_001
    - `id` string — Fonoa id representing a resource within the system. e.g., a7cc64422fc247069aa64d4fe8b387c5
    - `language_code` string — Specifies the language of the entity. Language code is an ISO 639-1 two-letter format (e.g, en, de, fr, etc.)
    - `legal_name` string — Full legal name of the company (or the individual). e.g., Acme LLC; John Fitzgerald Kennedy
    - `logo` string — url of the logo to be used in invoice documents for this company
    - `representative_email` string — Email address of the representative of the entity.
    - `representative_name` string — Full name of the representative of the entity.
    - `role` string — Role of the entity in the transaction (e.g., RECIPIENT). Used to distinguish different types of secondary entities.
    - `tax_information` TransactionEntityTaxInformationResponse
      - `accounting_basis` string — The supplier's method of tracking income and expenses in accounting
      - `activity_code` string — Activity code representing business activity of the entity.
      - `additional_tax_numbers` TransactionEntityTaxNumberCountrySpecific[] — Additional tax numbers used by the business entity when operating abroad.
        - `business_model` string[] — Applicable transaction business models (optional).
        - `country_code` string — Country where provided tax number should be used.
        - `country_subdivision_code` string — Country subdivision code where tax number should be used (optional).
        - `tax_number` string — Tax number.
        - `type` string — The tax number type (optional).
      - `authorization_code` string — Authorization code issued by TA.
      - `billing_file_number` string — Unique identifier assigned to individuals or entities to enable accurate and efficient invoicing processes.
      - `device_id` string — Device ID issued by tax authority.
      - `distribution_address` string — Value to be used by the Tax Authority to forward the reported invoice to the customer/buyer
      - `document_type` string — Type of document number (e.g. passport or national_id) provided in tax_number, if applicable.
      - `point_of_sale` string — Virtual point of sale number used by company when issuing invoices.
      - `regime` string — Tax regime the entity is registered with. e.g., VAT
      - `tax_code` string — Tax code that complements tax number.
      - `tax_number` string — Tax number of tax registered entity. e.g., 69061864-2-99
    - `template_configuration` TransactionEntityTemplateConfiguration
      - `color` string — The hexadecimal color value used for the invoice - example: 293d62
      - `font` string — The font used for the invoice. Some of the supported fonts include Abhaya Libre, Helvetica World, Hind, Lora, Open Sans, Rubik, among others. If you wish to have your own font please reach out to Fonoa support.
      - `logo_placement` string — Where on the invoice your logo will be placed - left or right
    - `trade_name` string — The name the company (or the individual) use to do business. e.g., Acme; John F Kennedy
    - `type` string — Entity type defining the type of the transaction (B2B or B2C).
  - `items` TransactionLineItemResponse[] — Goods, services, and discounts exchanged in a transaction.
    - `code` string — Item code used by Tax Authorities to classify transaction items. For example HSN (Harmonized System of Nomenclature). e.g., 08081000 - Apple More info can be found here - https://www.tariffnumber.com/"
    - `description` string — Description of an item required for SAF-T documents in PT. Not displayed on a visual document. e.g., Chocolate cookies taste better with milk.
    - `details` TransactionLineItemDetailResponse[] — Additional details describing the line item.
      - `name` string, required — Description of the line item detail that will be shared with the tax authority in supported countries. Validations: - Required property
      - `net_price` number — Net price of the line item detail. Indicated price excludes Tax.
      - `quantity` number — Quantity of the line item detail.
    - `ean` string — European article number (EAN) also known as International article number - EAN 13 - 13 digit barcode mandatory for PT reporting scenarios. e.g. 5012345678900.
    - `imported_content_code` string — Code for import content declaration.
    - `name` string — Item name displayed on an invoice. e.g., Chocolate cookies
    - `net_price` number — A decimal representing the item net price with precision up to 9 digits. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
    - `number` integer — Ordinal number of the item in a transaction. e.g., 1
    - `operation_nature_code` string — The code of the nature of this item in the transaction.
    - `product_classification_code` string — Identifies the product using a standardized classification system.
    - `quantity` number — Non-zero decimal representing the quantity of units of the line item. e.g., 3.1. e.g., 3.1
    - `reason` string — The reason this item is included on the invoice. Typically reserved for adjustments.
    - `reference_number` integer — Non-zero integer referring to one of the line items. Can be used only when item type is DISCOUNT indicating that the discount is applied to a specific item. If not specified, the discount is applied to the entire transaction. Item cannot reference itself.
    - `reference_transaction_id` string — The external transaction identifier of the original transaction the credit is referencing. e.g., MY_ORIGINAL_IDENTIFIER_0001
    - `reference_transaction_item_number` integer — An integer referring to the referenced transaction item the adjustment item applied to.
    - `reference_transaction_number` string — The transaction number of the original transaction the credit is referencing. e.g., 0001
    - `tax_breakdown` TransactionLineItemTaxBreakdownResponse[] — Taxes applied to a line item
      - `amount` number — A decimal representing the tax amount with precision up to 9 digits. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
      - `code` string — Tax code required by some tax authorities to justify the application of this tax, typically for items that are tax-exempt. The list of codes depends on the jurisdiction. e.g., M11 - Portuguese tobacco regime
      - `description` string — Description required by some tax authorities to justify the application of this tax, typically for items that are tax-exempt.
      - `rate` number — Non-negative tax rate percentage applied to an item. e.g. 25.
      - `regime` string — Name of the tax regime. e.g., VAT
      - `type` string — Tax type required by some tax authorities. e.g., PT tax authorities have different tax types per region. e.g., PT-MA - Madeira region tax type.
    - `tax_point_date` string — Date when the tax point for this line item occurs.
    - `type` string — Type of item in a transaction either GOODS, SERVICES, or DISCOUNT.
    - `unit` string — Unit of measurement for the item. e.g., pcs.
    - `unit_price` number — A decimal representing the unit price with precision up to 9 digits. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
  - `labels` TransactionLabelResponse[] — A list of transaction labels applied to the generated document.
    - `label` string — The descriptive name of the label
    - `value` string — The value associated with the label
  - `language_code` string — Language of the transaction document represented as ISO 639-1 uppercase language code. Required when document generation is enabled. Defaults to EN (English) if not provided.
  - `note` string — A text note attached to a transaction. Notes are HTML enabled and will be displayed on the visual document. e.g., This is my HTML <e>enabled</e> note.
  - `operation_id` string — The unique Fonoa identifier of a transaction request/operation.
  - `operation_regime` string — A value describing the operation regime for the transaction if applicable. e.g., export - indicating the transaction should be reported as cross-border transaction.
  - `operation_regime_details` string — A value describing the details of the operation regime specified on the transaction. e.g., provide export type supported by the tax authority.
  - `operational_context` OperationalContextResponse
    - `line_of_business` string — Classification of the business line this transaction belongs to. Used by Fonoa for pre-agreed purposes such as separate billing or data routing.
    - `source_system` string — Identifier for the internal system or application within the customer's organization that originated this transaction.
  - `operator` TransactionNonOnboardedEntityResponse
    - `address` TransactionEntityAddressResponse
      - `address_line_1` string — Street name and number of the company.
      - `address_line_2` string
      - `canton` string
      - `city` string — The city where the legal entity that is being onboarded is registered.
      - `city_code` string
      - `country_code` string — ISO 3166-1 alpha-2 uppercase country code of the country where entity is registered.
      - `district` string
      - `neighbourhood` string
      - `number` string
      - `postal_code` string — Postal code of the city where the company is registered.
      - `prefix` string
      - `province` string
      - `region` string
      - `state` string
      - `suffix` string
    - `contact_details` TransactionEntityContactDetailsResponse
      - `certified_email` string — The certified email of the entity.
      - `email` string — Email contact of the entity.
      - `phone_number` string — The phone number contact of the entity.
      - `website` string — Website address of the entity.
    - `country_code` string — Specifies the country of the entity. Country code is an ISO 3166-1 two-letter format (e.g, us, de, fr, etc.)
    - `entity_number` string — This is a company registration number if entity is a business or personal identifier if entity is an individual. e.g., 011589551
    - `entity_number_type` string — This is company or individual number type. e.g., 93 (Argentina - birth certificate)
    - `establishment_date` string — The date when the company was established or business activity started. Establishment Date should be in ISO8601 standard.
    - `external_id` string — External resource identifier provided by the customer. e.g., MY_EXTERNAL_ID_001
    - `id` string — Fonoa id representing a resource within the system. e.g., a7cc64422fc247069aa64d4fe8b387c5
    - `language_code` string — Specifies the language of the entity. Language code is an ISO 639-1 two-letter format (e.g, en, de, fr, etc.)
    - `legal_name` string — Full legal name of the company (or the individual). e.g., Acme LLC; John Fitzgerald Kennedy
    - `logo` string — url of the logo to be used in invoice documents for this company
    - `representative_email` string — Email address of the representative of the entity.
    - `representative_name` string — Full name of the representative of the entity.
    - `role` string — Role of the entity in the transaction (e.g., RECIPIENT). Used to distinguish different types of secondary entities.
    - `tax_information` TransactionEntityTaxInformationResponse
      - `accounting_basis` string — The supplier's method of tracking income and expenses in accounting
      - `activity_code` string — Activity code representing business activity of the entity.
      - `additional_tax_numbers` TransactionEntityTaxNumberCountrySpecific[] — Additional tax numbers used by the business entity when operating abroad.
        - `business_model` string[] — Applicable transaction business models (optional).
        - `country_code` string — Country where provided tax number should be used.
        - `country_subdivision_code` string — Country subdivision code where tax number should be used (optional).
        - `tax_number` string — Tax number.
        - `type` string — The tax number type (optional).
      - `authorization_code` string — Authorization code issued by TA.
      - `billing_file_number` string — Unique identifier assigned to individuals or entities to enable accurate and efficient invoicing processes.
      - `device_id` string — Device ID issued by tax authority.
      - `distribution_address` string — Value to be used by the Tax Authority to forward the reported invoice to the customer/buyer
      - `document_type` string — Type of document number (e.g. passport or national_id) provided in tax_number, if applicable.
      - `point_of_sale` string — Virtual point of sale number used by company when issuing invoices.
      - `regime` string — Tax regime the entity is registered with. e.g., VAT
      - `tax_code` string — Tax code that complements tax number.
      - `tax_number` string — Tax number of tax registered entity. e.g., 69061864-2-99
    - `template_configuration` TransactionEntityTemplateConfiguration
      - `color` string — The hexadecimal color value used for the invoice - example: 293d62
      - `font` string — The font used for the invoice. Some of the supported fonts include Abhaya Libre, Helvetica World, Hind, Lora, Open Sans, Rubik, among others. If you wish to have your own font please reach out to Fonoa support.
      - `logo_placement` string — Where on the invoice your logo will be placed - left or right
    - `trade_name` string — The name the company (or the individual) use to do business. e.g., Acme; John F Kennedy
    - `type` string — Entity type defining the type of the transaction (B2B or B2C).
  - `payment_details` TransactionPaymentDetailResponse[] — Payment details for the transaction.
    - `bank_info` PaymentDetailBankInfoResponse
      - `account_holder_name` string — The name of the account holder as registered with the bank.
      - `account_number` string — Bank account number used for the payment. e.g., 1234567890
      - `bank_identifier` string — Bank identifier used for account identification, for example BIC or SWIFT. example: ZABAHR2X
      - `bank_name` string — Name of the bank where the payment was made. e.g., Bank of America
    - `condition` string — Indicates the structure of payment. Acceptable values are: FULL (One-time payment for the full amount), INSTALLMENTS (Multiple scheduled payments), or ADVANCE (Prepayment before goods/services are delivered).
    - `payments` TransactionPaymentResponse[] — The list of payments related to the condition specified.
      - `amount` number — A decimal representing the amount paid by the payment type with precision up to 9 digits. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
      - `card_brand` string — Card brand used for the payment. e.g., Visa, MasterCard, Amex
      - `code` string — Payment type code required by some tax authorities. e.g., single payment, deferred payment, installments... e.g., PUE - Mexican payment code for single payment.
      - `date_of_payment` string — Date of the payment. e.g., 2021-01-01T00:00:00Z
      - `payment_processor` PaymentProcessorResponse
        - `authorization_code` string — Authorization code of the payment processor. e.g., 123456
        - `integration_type` string — Type of integration with the payment processor
        - `tax_number` string — Tax number of the payment processor. e.g., 69061864-2-99
        - `terminal_id` string — Terminal ID of the payment processor. e.g., 1234567890
      - `settlements` PaymentSettlementResponse[] — A list of payment settlements representing how this payment is applied against one or more prior transactions.
        - `instalment_number` integer — The sequential number of the instalment this settlement represents (e.g., 1 for the first payment, 2 for the second).
        - `outstanding_balance` number — The remaining unpaid balance on the original transaction after this settlement is applied.
        - `reference_transaction_id` string — The external transaction identifier of the original transaction that this payment is settles.
        - `settled_amounts` SettledAmountResponse[] — A list detailing how the payment amount is allocated - including the base (untaxed) amounts and any associated taxes.
          - `base_amount` number — The untaxed portion of the settled amount.
          - `tax_breakdown` TransactionLineItemTaxBreakdownResponse[] — A detailed list of applied taxes (e.g., VAT, withholding, etc.) corresponding to this settled base amount.
            - `amount` number — A decimal representing the tax amount with precision up to 9 digits. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
            - `code` string — Tax code required by some tax authorities to justify the application of this tax, typically for items that are tax-exempt. The list of codes depends on the jurisdiction. e.g., M11 - Portuguese tobacco regime
            - `description` string — Description required by some tax authorities to justify the application of this tax, typically for items that are tax-exempt.
            - `rate` number — Non-negative tax rate percentage applied to an item. e.g. 25.
            - `regime` string — Name of the tax regime. e.g., VAT
            - `type` string — Tax type required by some tax authorities. e.g., PT tax authorities have different tax types per region. e.g., PT-MA - Madeira region tax type.
      - `type` string — Free text input or one of predefined values representing payment type. Predefined values (CARD, CASH, CHECK, TRANSACTION, CREDITCARD, DEBITCARD, OTHER) are localized. e.g., CARD ending in 2022
  - `payment_due_date` string — RFC3339 datetime string representing the deadline until which the payment must be made.
  - `payments` TransactionPaymentResponse[] — A list of transaction payments. The sum of all payment amounts must match the total transaction amount. i.e., sum(payments[].amount) == sum(items[].quantity * items[].unit_price * (1 + sum(tax_breakdown[].rate)/100))
    - `amount` number — A decimal representing the amount paid by the payment type with precision up to 9 digits. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
    - `card_brand` string — Card brand used for the payment. e.g., Visa, MasterCard, Amex
    - `code` string — Payment type code required by some tax authorities. e.g., single payment, deferred payment, installments... e.g., PUE - Mexican payment code for single payment.
    - `date_of_payment` string — Date of the payment. e.g., 2021-01-01T00:00:00Z
    - `payment_processor` PaymentProcessorResponse
      - `authorization_code` string — Authorization code of the payment processor. e.g., 123456
      - `integration_type` string — Type of integration with the payment processor
      - `tax_number` string — Tax number of the payment processor. e.g., 69061864-2-99
      - `terminal_id` string — Terminal ID of the payment processor. e.g., 1234567890
    - `settlements` PaymentSettlementResponse[] — A list of payment settlements representing how this payment is applied against one or more prior transactions.
      - `instalment_number` integer — The sequential number of the instalment this settlement represents (e.g., 1 for the first payment, 2 for the second).
      - `outstanding_balance` number — The remaining unpaid balance on the original transaction after this settlement is applied.
      - `reference_transaction_id` string — The external transaction identifier of the original transaction that this payment is settles.
      - `settled_amounts` SettledAmountResponse[] — A list detailing how the payment amount is allocated - including the base (untaxed) amounts and any associated taxes.
        - `base_amount` number — The untaxed portion of the settled amount.
        - `tax_breakdown` TransactionLineItemTaxBreakdownResponse[] — A detailed list of applied taxes (e.g., VAT, withholding, etc.) corresponding to this settled base amount.
          - `amount` number — A decimal representing the tax amount with precision up to 9 digits. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
          - `code` string — Tax code required by some tax authorities to justify the application of this tax, typically for items that are tax-exempt. The list of codes depends on the jurisdiction. e.g., M11 - Portuguese tobacco regime
          - `description` string — Description required by some tax authorities to justify the application of this tax, typically for items that are tax-exempt.
          - `rate` number — Non-negative tax rate percentage applied to an item. e.g. 25.
          - `regime` string — Name of the tax regime. e.g., VAT
          - `type` string — Tax type required by some tax authorities. e.g., PT tax authorities have different tax types per region. e.g., PT-MA - Madeira region tax type.
    - `type` string — Free text input or one of predefined values representing payment type. Predefined values (CARD, CASH, CHECK, TRANSACTION, CREDITCARD, DEBITCARD, OTHER) are localized. e.g., CARD ending in 2022
  - `pos_device` PosDeviceResponse
    - `code` string — The code of the pos device.
  - `purchase_orders` DocumentReferenceResponse[] — Buyer’s purchase orders information (e.g., PO number) this document relates to.
    - `identifier` string — Buyer’s document reference identifier (e.g., PO number) identifying the document this invoice relates to.
    - `issue_date` string — Date when the referenced document was issued. Validations: - Must be an RFC3339 format date
    - `reason` string — Reason for the document reference.
    - `tender_reference` string — Identifier of the procurement procedure or tender associated with the referenced document.
    - `type` string — Type of the document reference.
  - `qr_code` string — A country-specific QR code displayed on a visual document usually used to verify the validity of the document against the Tax Authority. e.g., Croatian QR code - https://porezna.gov.hr/rn/?zki=3b767891212f678bd9f697b6a06f2191&datv=20231226_1929&izn=9915
  - `reference_transaction_id` string — The external transaction identifier of the original transaction the credit is referencing. e.g., MY_ORIGINAL_IDENTIFIER_0001
  - `reference_transaction_number` string — The transaction number of the original transaction the credit is referencing. e.g., 0001
  - `reported_at` string — RFC3339 timestamp when the transaction was reported to the tax authorities.
  - `secondary_currency` TransactionSecondaryCurrencyResponse
    - `currency_code` string — ISO 4217 currency code of the secondary transaction currency. e.g., MXN
    - `exchange_date` string — Date of the currency exchange rate. e.g., 2021-01-01T00:00:00Z
    - `exchange_rate` number — Currency exchange rate between main and secondary transaction currency. e.g., 1.12.
  - `secondary_entities` TransactionNonOnboardedEntityResponse[] — Secondary entities involved in the transaction. e.g., buyer agency, buyer branch information, supplier payee, etc.
    - `address` TransactionEntityAddressResponse
      - `address_line_1` string — Street name and number of the company.
      - `address_line_2` string
      - `canton` string
      - `city` string — The city where the legal entity that is being onboarded is registered.
      - `city_code` string
      - `country_code` string — ISO 3166-1 alpha-2 uppercase country code of the country where entity is registered.
      - `district` string
      - `neighbourhood` string
      - `number` string
      - `postal_code` string — Postal code of the city where the company is registered.
      - `prefix` string
      - `province` string
      - `region` string
      - `state` string
      - `suffix` string
    - `contact_details` TransactionEntityContactDetailsResponse
      - `certified_email` string — The certified email of the entity.
      - `email` string — Email contact of the entity.
      - `phone_number` string — The phone number contact of the entity.
      - `website` string — Website address of the entity.
    - `country_code` string — Specifies the country of the entity. Country code is an ISO 3166-1 two-letter format (e.g, us, de, fr, etc.)
    - `entity_number` string — This is a company registration number if entity is a business or personal identifier if entity is an individual. e.g., 011589551
    - `entity_number_type` string — This is company or individual number type. e.g., 93 (Argentina - birth certificate)
    - `establishment_date` string — The date when the company was established or business activity started. Establishment Date should be in ISO8601 standard.
    - `external_id` string — External resource identifier provided by the customer. e.g., MY_EXTERNAL_ID_001
    - `id` string — Fonoa id representing a resource within the system. e.g., a7cc64422fc247069aa64d4fe8b387c5
    - `language_code` string — Specifies the language of the entity. Language code is an ISO 639-1 two-letter format (e.g, en, de, fr, etc.)
    - `legal_name` string — Full legal name of the company (or the individual). e.g., Acme LLC; John Fitzgerald Kennedy
    - `logo` string — url of the logo to be used in invoice documents for this company
    - `representative_email` string — Email address of the representative of the entity.
    - `representative_name` string — Full name of the representative of the entity.
    - `role` string — Role of the entity in the transaction (e.g., RECIPIENT). Used to distinguish different types of secondary entities.
    - `tax_information` TransactionEntityTaxInformationResponse
      - `accounting_basis` string — The supplier's method of tracking income and expenses in accounting
      - `activity_code` string — Activity code representing business activity of the entity.
      - `additional_tax_numbers` TransactionEntityTaxNumberCountrySpecific[] — Additional tax numbers used by the business entity when operating abroad.
        - `business_model` string[] — Applicable transaction business models (optional).
        - `country_code` string — Country where provided tax number should be used.
        - `country_subdivision_code` string — Country subdivision code where tax number should be used (optional).
        - `tax_number` string — Tax number.
        - `type` string — The tax number type (optional).
      - `authorization_code` string — Authorization code issued by TA.
      - `billing_file_number` string — Unique identifier assigned to individuals or entities to enable accurate and efficient invoicing processes.
      - `device_id` string — Device ID issued by tax authority.
      - `distribution_address` string — Value to be used by the Tax Authority to forward the reported invoice to the customer/buyer
      - `document_type` string — Type of document number (e.g. passport or national_id) provided in tax_number, if applicable.
      - `point_of_sale` string — Virtual point of sale number used by company when issuing invoices.
      - `regime` string — Tax regime the entity is registered with. e.g., VAT
      - `tax_code` string — Tax code that complements tax number.
      - `tax_number` string — Tax number of tax registered entity. e.g., 69061864-2-99
    - `template_configuration` TransactionEntityTemplateConfiguration
      - `color` string — The hexadecimal color value used for the invoice - example: 293d62
      - `font` string — The font used for the invoice. Some of the supported fonts include Abhaya Libre, Helvetica World, Hind, Lora, Open Sans, Rubik, among others. If you wish to have your own font please reach out to Fonoa support.
      - `logo_placement` string — Where on the invoice your logo will be placed - left or right
    - `trade_name` string — The name the company (or the individual) use to do business. e.g., Acme; John F Kennedy
    - `type` string — Entity type defining the type of the transaction (B2B or B2C).
  - `series` string — 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
  - `signature` string — The transaction signature generated by an external application.
  - `signature_date` string — The date of the transaction signature generated by an external application.
  - `start_date` string — RFC3339 datetime string representing a starting point in time.
  - `status` string — Status of the transaction.
  - `supplier` TransactionNonOnboardedEntityResponse
    - `address` TransactionEntityAddressResponse
      - `address_line_1` string — Street name and number of the company.
      - `address_line_2` string
      - `canton` string
      - `city` string — The city where the legal entity that is being onboarded is registered.
      - `city_code` string
      - `country_code` string — ISO 3166-1 alpha-2 uppercase country code of the country where entity is registered.
      - `district` string
      - `neighbourhood` string
      - `number` string
      - `postal_code` string — Postal code of the city where the company is registered.
      - `prefix` string
      - `province` string
      - `region` string
      - `state` string
      - `suffix` string
    - `contact_details` TransactionEntityContactDetailsResponse
      - `certified_email` string — The certified email of the entity.
      - `email` string — Email contact of the entity.
      - `phone_number` string — The phone number contact of the entity.
      - `website` string — Website address of the entity.
    - `country_code` string — Specifies the country of the entity. Country code is an ISO 3166-1 two-letter format (e.g, us, de, fr, etc.)
    - `entity_number` string — This is a company registration number if entity is a business or personal identifier if entity is an individual. e.g., 011589551
    - `entity_number_type` string — This is company or individual number type. e.g., 93 (Argentina - birth certificate)
    - `establishment_date` string — The date when the company was established or business activity started. Establishment Date should be in ISO8601 standard.
    - `external_id` string — External resource identifier provided by the customer. e.g., MY_EXTERNAL_ID_001
    - `id` string — Fonoa id representing a resource within the system. e.g., a7cc64422fc247069aa64d4fe8b387c5
    - `language_code` string — Specifies the language of the entity. Language code is an ISO 639-1 two-letter format (e.g, en, de, fr, etc.)
    - `legal_name` string — Full legal name of the company (or the individual). e.g., Acme LLC; John Fitzgerald Kennedy
    - `logo` string — url of the logo to be used in invoice documents for this company
    - `representative_email` string — Email address of the representative of the entity.
    - `representative_name` string — Full name of the representative of the entity.
    - `role` string — Role of the entity in the transaction (e.g., RECIPIENT). Used to distinguish different types of secondary entities.
    - `tax_information` TransactionEntityTaxInformationResponse
      - `accounting_basis` string — The supplier's method of tracking income and expenses in accounting
      - `activity_code` string — Activity code representing business activity of the entity.
      - `additional_tax_numbers` TransactionEntityTaxNumberCountrySpecific[] — Additional tax numbers used by the business entity when operating abroad.
        - `business_model` string[] — Applicable transaction business models (optional).
        - `country_code` string — Country where provided tax number should be used.
        - `country_subdivision_code` string — Country subdivision code where tax number should be used (optional).
        - `tax_number` string — Tax number.
        - `type` string — The tax number type (optional).
      - `authorization_code` string — Authorization code issued by TA.
      - `billing_file_number` string — Unique identifier assigned to individuals or entities to enable accurate and efficient invoicing processes.
      - `device_id` string — Device ID issued by tax authority.
      - `distribution_address` string — Value to be used by the Tax Authority to forward the reported invoice to the customer/buyer
      - `document_type` string — Type of document number (e.g. passport or national_id) provided in tax_number, if applicable.
      - `point_of_sale` string — Virtual point of sale number used by company when issuing invoices.
      - `regime` string — Tax regime the entity is registered with. e.g., VAT
      - `tax_code` string — Tax code that complements tax number.
      - `tax_number` string — Tax number of tax registered entity. e.g., 69061864-2-99
    - `template_configuration` TransactionEntityTemplateConfiguration
      - `color` string — The hexadecimal color value used for the invoice - example: 293d62
      - `font` string — The font used for the invoice. Some of the supported fonts include Abhaya Libre, Helvetica World, Hind, Lora, Open Sans, Rubik, among others. If you wish to have your own font please reach out to Fonoa support.
      - `logo_placement` string — Where on the invoice your logo will be placed - left or right
    - `trade_name` string — The name the company (or the individual) use to do business. e.g., Acme; John F Kennedy
    - `type` string — Entity type defining the type of the transaction (B2B or B2C).
  - `tax_authority_id_1` string — Main transaction identifier returned by the tax authorities. e.g., JIR in Croatia.
  - `tax_authority_id_2` string — Secondary transaction identifier returned by the tax authorities. e.g., ZKI in Croatia.
  - `tax_reason` TransactionTaxReason
    - `code` string, required — The specific code to be used as the tax reason for the transaction. e.g., S01 - indicating no tax effect in Mexican jurisdiction Validations: - Maximum length: 15 - Required property
    - `description` string — Further explanation of the tax reason for the code provided Validations: - Maximum length: 450
    - `tax_reason_details` TransactionTaxReasonDetail[] — Additional details to be provided for the tax reason code. Validations: - This field is only supported in specific use cases, refer to country-specific integration guides in the Fonoa dashboard.
      - `code` string — Additional code that complements the tax reason code. For example, specific refusal code for refusal tax reason. Validations: - Maximum length: 30
      - `note` string — Further explanation of the tax reason detail for the code provided Validations: - Maximum length: 450
  - `total_amount` number — Decimal representing total transaction amount with precision up to 9 digits. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
  - `total_net_amount` number — Decimal representing sum of item net values with precision up to 9 digits. Does not include discounts. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
  - `total_tax_amount` number — Decimal representing sum of all taxes applied to the transaction items with precision up to 9 digits. If you are using the legacy integer representation for this field refer to this documentation on how to migrate to decimals: https://docs.fonoa.com/reference/amounts-and-rounding
  - `transaction_channel` string — The channel through which the transaction was conducted, such as in-person, online, telephone order, etc.
  - `transaction_date` string — RFC3339 datetime string representing the point in time when transaction is executed.
  - `transaction_id` string — External transaction identifier provided by the customer.
  - `transaction_number` string — Locally compliant transaction number.
  - `transaction_scenario` string — Represents the type of document that needs to be issued depending on the transaction debiting or crediting effect on the TA. Possible values are: DEBIT, FULL_CREDIT, CANCELLATION, DEBIT_ADJUSTMENT, CREDIT_ADJUSTMENT
  - `transport_data` TransactionTransportDataResponse
    - `recipient` TransactionNonOnboardedEntityResponse
      - `address` TransactionEntityAddressResponse
        - `address_line_1` string — Street name and number of the company.
        - `address_line_2` string
        - `canton` string
        - `city` string — The city where the legal entity that is being onboarded is registered.
        - `city_code` string
        - `country_code` string — ISO 3166-1 alpha-2 uppercase country code of the country where entity is registered.
        - `district` string
        - `neighbourhood` string
        - `number` string
        - `postal_code` string — Postal code of the city where the company is registered.
        - `prefix` string
        - `province` string
        - `region` string
        - `state` string
        - `suffix` string
      - `contact_details` TransactionEntityContactDetailsResponse
        - `certified_email` string — The certified email of the entity.
        - `email` string — Email contact of the entity.
        - `phone_number` string — The phone number contact of the entity.
        - `website` string — Website address of the entity.
      - `country_code` string — Specifies the country of the entity. Country code is an ISO 3166-1 two-letter format (e.g, us, de, fr, etc.)
      - `entity_number` string — This is a company registration number if entity is a business or personal identifier if entity is an individual. e.g., 011589551
      - `entity_number_type` string — This is company or individual number type. e.g., 93 (Argentina - birth certificate)
      - `establishment_date` string — The date when the company was established or business activity started. Establishment Date should be in ISO8601 standard.
      - `external_id` string — External resource identifier provided by the customer. e.g., MY_EXTERNAL_ID_001
      - `id` string — Fonoa id representing a resource within the system. e.g., a7cc64422fc247069aa64d4fe8b387c5
      - `language_code` string — Specifies the language of the entity. Language code is an ISO 639-1 two-letter format (e.g, en, de, fr, etc.)
      - `legal_name` string — Full legal name of the company (or the individual). e.g., Acme LLC; John Fitzgerald Kennedy
      - `logo` string — url of the logo to be used in invoice documents for this company
      - `representative_email` string — Email address of the representative of the entity.
      - `representative_name` string — Full name of the representative of the entity.
      - `role` string — Role of the entity in the transaction (e.g., RECIPIENT). Used to distinguish different types of secondary entities.
      - `tax_information` TransactionEntityTaxInformationResponse
        - `accounting_basis` string — The supplier's method of tracking income and expenses in accounting
        - `activity_code` string — Activity code representing business activity of the entity.
        - `additional_tax_numbers` TransactionEntityTaxNumberCountrySpecific[] — Additional tax numbers used by the business entity when operating abroad.
          - `business_model` string[] — Applicable transaction business models (optional).
          - `country_code` string — Country where provided tax number should be used.
          - `country_subdivision_code` string — Country subdivision code where tax number should be used (optional).
          - `tax_number` string — Tax number.
          - `type` string — The tax number type (optional).
        - `authorization_code` string — Authorization code issued by TA.
        - `billing_file_number` string — Unique identifier assigned to individuals or entities to enable accurate and efficient invoicing processes.
        - `device_id` string — Device ID issued by tax authority.
        - `distribution_address` string — Value to be used by the Tax Authority to forward the reported invoice to the customer/buyer
        - `document_type` string — Type of document number (e.g. passport or national_id) provided in tax_number, if applicable.
        - `point_of_sale` string — Virtual point of sale number used by company when issuing invoices.
        - `regime` string — Tax regime the entity is registered with. e.g., VAT
        - `tax_code` string — Tax code that complements tax number.
        - `tax_number` string — Tax number of tax registered entity. e.g., 69061864-2-99
      - `template_configuration` TransactionEntityTemplateConfiguration
        - `color` string — The hexadecimal color value used for the invoice - example: 293d62
        - `font` string — The font used for the invoice. Some of the supported fonts include Abhaya Libre, Helvetica World, Hind, Lora, Open Sans, Rubik, among others. If you wish to have your own font please reach out to Fonoa support.
        - `logo_placement` string — Where on the invoice your logo will be placed - left or right
      - `trade_name` string — The name the company (or the individual) use to do business. e.g., Acme; John F Kennedy
      - `type` string — Entity type defining the type of the transaction (B2B or B2C).
    - `shipping_from` TransactionEntityAddressResponse
      - `address_line_1` string — Street name and number of the company.
      - `address_line_2` string
      - `canton` string
      - `city` string — The city where the legal entity that is being onboarded is registered.
      - `city_code` string
      - `country_code` string — ISO 3166-1 alpha-2 uppercase country code of the country where entity is registered.
      - `district` string
      - `neighbourhood` string
      - `number` string
      - `postal_code` string — Postal code of the city where the company is registered.
      - `prefix` string
      - `province` string
      - `region` string
      - `state` string
      - `suffix` string
    - `shipping_to` TransactionEntityAddressResponse
      - `address_line_1` string — Street name and number of the company.
      - `address_line_2` string
      - `canton` string
      - `city` string — The city where the legal entity that is being onboarded is registered.
      - `city_code` string
      - `country_code` string — ISO 3166-1 alpha-2 uppercase country code of the country where entity is registered.
      - `district` string
      - `neighbourhood` string
      - `number` string
      - `postal_code` string — Postal code of the city where the company is registered.
      - `prefix` string
      - `province` string
      - `region` string
      - `state` string
      - `suffix` string
    - `transport_mode` string — Defines how the transport was managed. Validations: - Values allowed are (letter case matters): WITHOUT_CHARGE, HIRED_BY_SENDER, HIRED_BY_RECIPIENT, HIRED_BY_THIRD_PARTY, OWNED_BY_SENDER, OWNED_BY_RECIPIENT
  - `type` string — Type of the transaction that usually depends on transaction value and business model (B2B or B2C). The two most common types are FULL and SIMPLIFIED.
  - `unique_transaction_number` string — An extension of transaction number including unique keys such as fiscal year and supplier information. Used by marketplaces to disambiguate duplicate transaction numbers. e.g., 2022-SUP001-000001

## Other responses

- `400` — Bad customer request - the provided operation_id is incorrect.
- `401` — Authentication failed - missing or incorrect subscription key
- `404` — Not found - transaction with the provided operation_id was not found.
- `429` — Too many requests were sent for a short period of time. Try again a bit later.
- `5XX` — Internal server error. Its not you, its us! We are experiencing a rare and unexpected system disruption. Retry again later. The message field of the response will contain more information for the cause. Feel free to contact us.

---

[API](https://skmtc.net/fonoa/apis/fonoa-api.md) · [All operations](https://skmtc.net/fonoa/apis/fonoa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fonoa/fonoa-api/versions/cf0ebc843a3f/schema)