Sign in

v18

latestOpenAPI 3.0.0raw.githubusercontent.com2024-11-18167108845.6 KB
accounting/payments

Create Payments

Create Payments in any supported Accounting software

post/accounting/payments

Query parameters

remote_databoolean

Set to true to include data from the original Accounting software.

Headers

x-connection-tokenstring required

The connection token

Request body

invoice_idstring nullable

The UUID of the associated invoice

transaction_datestring date-time nullable

The date of the transaction

contact_idstring nullable

The UUID of the associated contact

account_idstring nullable

The UUID of the associated account

currencystring nullable

The currency of the payment

exchange_ratestring nullable

The exchange rate applied to the payment

total_amountnumber nullable

The total amount of the payment in cents

typestring nullable

The type of payment

company_info_idstring nullable

The UUID of the associated company info

accounting_period_idstring nullable

The UUID of the associated accounting period

tracking_categoriesstring[] nullable

The UUIDs of the tracking categories associated with the payment

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

Example request

{
  "invoice_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "transaction_date": "2024-06-15T12:00:00Z",
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "account_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "currency": "USD",
  "exchange_rate": "1.2",
  "total_amount": 10000,
  "type": "Credit Card",
  "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "accounting_period_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "tracking_categories": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "line_items": [
    {
      "name": "Net Income",
      "value": 100000,
      "type": "Operating Activities",
      "parent_item": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "report_item_1234",
      "remote_generated_at": "2024-07-01T12:00:00Z",
      "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "created_at": "2024-06-15T12:00:00Z",
      "modified_at": "2024-06-15T12:00:00Z"
    }
  ],
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  }
}

Response

invoice_idstring nullable

The UUID of the associated invoice

transaction_datestring date-time nullable

The date of the transaction

contact_idstring nullable

The UUID of the associated contact

account_idstring nullable

The UUID of the associated account

currencystring nullable

The currency of the payment

exchange_ratestring nullable

The exchange rate applied to the payment

total_amountnumber nullable

The total amount of the payment in cents

typestring nullable

The type of payment

company_info_idstring nullable

The UUID of the associated company info

accounting_period_idstring nullable

The UUID of the associated accounting period

tracking_categoriesstring[] nullable

The UUIDs of the tracking categories associated with the payment

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the payment record

remote_idstring nullable

The remote ID of the payment in the context of the 3rd Party

remote_updated_atstring date-time nullable

The date when the payment was last updated in the remote system

remote_dataobject nullable

The remote data of the payment in the context of the 3rd Party

created_atstring date-time nullable

The created date of the payment record

modified_atstring date-time nullable

The last modified date of the payment record

Example response

{
  "invoice_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "transaction_date": "2024-06-15T12:00:00Z",
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "account_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "currency": "USD",
  "exchange_rate": "1.2",
  "total_amount": 10000,
  "type": "Credit Card",
  "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "accounting_period_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "tracking_categories": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "line_items": [
    {
      "name": "Net Income",
      "value": 100000,
      "type": "Operating Activities",
      "parent_item": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "report_item_1234",
      "remote_generated_at": "2024-07-01T12:00:00Z",
      "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "created_at": "2024-06-15T12:00:00Z",
      "modified_at": "2024-06-15T12:00:00Z"
    }
  ],
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "payment_1234",
  "remote_updated_at": "2024-06-15T12:00:00Z",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "created_at": "2024-06-15T12:00:00Z",
  "modified_at": "2024-06-15T12:00:00Z"
}