--- title: "Get a list of transactions" method: GET path: "/v1/transactions" tags: ["Transactions"] --- # Get a list of transactions `GET /v1/transactions` ## Request - The document declares no server URL. - Auth: API key in header `Ocp-Apim-Subscription-Key` Used to search for transactions. ## Query parameters - `backfill` boolean - `country_code` string - `data_source` string - `decimal_amounts` boolean - `direction` string - `document_flow` string - `error_types` string[] - `limit` integer - `next_cursor` string - `operation_id` string - `reporting_date_from` string - `reporting_date_to` string - `sort_by` string - `sort_order` string - `supplier_company_id` string - `supplier_company_name` string - `transaction_date_from` string - `transaction_date_to` string - `transaction_id` string[] - `transaction_number` string[] - `transaction_reference_id` string - `transaction_scenario` string - `transaction_status` string - `transaction_type` string - `updated_at_from` string - `updated_at_to` string - `workflow_operations` string - `workflow_status` string ## Response `200` Ok - transactions for the provided search criteria were returned. - SearchTransactionsResponse - `limit` integer - `next_cursor` string - `transactions` SearchDashboardTransaction[] - `backfill` boolean: Indicates whether the transaction is a backfill. - `country_code` string: ISO 3166-1 alpha-2 uppercase country code of the country where the transaction was reported. - `currency_code` string: Primary currency code of the transaction represented as ISO 4217 3 letter uppercase currency code e.g. `USD`. - `customer` SearchTransactionCustomerResponse - `external_id` string: External (clients) unique identifier for the customer. - `id` string: Fonoa unique identifier for the customer. - `name` string: Customer name. - `data_source` string: Indicates the input source of the transaction, e.g. `API`, `CSV`. - `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`. - `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 - `last_updated_date` string: RFC3339 datetime string representing the last point in time of a transaction update. - `operation_id` string: The unique Fonoa identifier of a transaction request/operation. - `reporting_date` string: RFC3339 datetime string representing the point in time when transaction is reported. - `status` string: Status of the transaction. - `supplier` SearchTransactionSupplierResponse - `country_code` string: ISO 3166-1 alpha-2 uppercase country code of the country where supplier is registered. - `external_id` string: External (clients) unique identifier for the supplier. - `id` string: Fonoa unique identifier for the supplier. - `name` string: Supplier name. - `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: Total amount (net + tax) for the entire transaction - `total_net_amount` number: Total net amount for the entire transaction. - `total_tax_amount` number: Total tax amount for the entire transaction - `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: Transaction number for the transaction. - `transaction_scenario` string: Represents the type of document that needs to be issued depending on the transaction debiting or crediting effect on the TA - `type` string: Type of the transaction that usually depends on transaction value and business model (B2B or B2C). The most common types are FULL, SIMPLIFIED, RECEIPT, RECEIPT_INVOICE. - `user_activities` SearchTransactionUserActivitiesResponse - `invoice_downloaded` SearchTransactionUserActivityResponse - `time` string: Date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z when the action was performed. - `type` string: Activity type. Allowed values: `INVOICE_DOWNLOADED` - `user_id` string: ID of the user that performed the action - `workflow_operations` WorkflowOperation[]: List of possible operations for a transactions. - `status` string: Status of the operation. Allowed values: `UNSPECIFIED`, `PENDING`, `PROCESSING`, `SUCCESS`, `FAILURE`, `SKIPPED`. - `type` string: Operation type. Allowed values: `REPORTING`, `INVOICING`. - `workflow_status` string: Status of the transaction workflow. ## Other responses - `400`: Bad customer request - invalid search parameters. - `401`: Authentication failed - missing or incorrect subscription key - `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.dev/fonoa/apis/fonoa-e-invoicing.md) - [All operations](https://skmtc.dev/fonoa/apis/fonoa-e-invoicing/llms.txt) - [OpenAPI document](https://skmtc.dev/fonoa/apis/fonoa-e-invoicing/revisions/d38890cb6fcd?raw)