Misc. Expenses/Credits

Add a New Event Miscellaneous Expense/Credit

Documentation: https://api.exhibitday.com/Help/V1?epf=100#post-v1-events-miscexpensecredit

post/v1/events/miscexpensecredit

Request

  • Base URL: https://api.exhibitday.com
  • URL: https://api.exhibitday.com/v1/events/miscexpensecredit
  • Auth: one of:
    • API key in header api_key
    • API key in query parameter api_key

Headers

Idempotency-Keystring

A unique value (e.g. a UUID) for this create. If you retry with the same key within 24 hours, you get the first response again instead of a second record. A 409 idempotency_key_in_use means the first request is still running (retry shortly with the same key); 409 idempotency_key_indeterminate means it never finished (check whether the record exists, then use a new key). The same key with a different request is refused with 400 idempotency_key_reused. A key is 1 to 255 visible ASCII characters, without spaces.

Request body

event_idinteger required

The id of the event you would like to add the miscellaneous expense/credit to.

descriptionstring required

A short description of the miscellaneous expense/credit. Longer values are truncated to 1000 characters.

is_creditboolean

The is_credit flag indicates whether or not the miscellaneous expense/credit you’re adding is a credit. For example, if you’re adding a partial credit the event organizer issued for a booth service, set the is_credit flag to true. Accepted values: true or false (also yes/no, 1/0); any other value is rejected with an error.

amountnumber

Use the amount field to specify the amount of the miscellaneous expense/credit. The value of this field should be a decimal with no currency symbols or commas (e.g., 11250.75). If the miscellaneous expense/credit you’re adding is a credit, pass in a positive number for the amount field, and set the is_credit flag to true. If you leave amount out, the amount is the sum of the charges in amount_cost_center_breakdown (0.00 when there is none).

amount_cost_center_breakdownstring

The cost center allocations as a JSON array of cost_center_id and charge values. Use cost center IDs from /v1/references/cost_centers, or null for Unassigned (responses show it as cost_center "Not Specified"). Charges must be nonnegative and must not exceed the amount in total; any unallocated remainder is assigned to Unassigned. If amount is omitted, the charges determine the total. Invalid JSON, unknown cost centers, negative charges, and allocations exceeding the amount return HTTP 400 without saving changes. For example, to allocate $100, send [{"cost_center_id": 123456, "charge": 60.00}, {"cost_center_id": null, "charge": 40.00}].

payment_status_idinteger

The Payment Status Id for the miscellaneous expense/credit. Note: Payment status only applies to miscellaneous expenses. If you pass in a payment_status_id for a miscellaneous credit (i.e., when the is_credit flag is set to true), it will be ignored. You can use the following endpoint to retrieve a list of available payment_status_id's: /v1/references/payment_statuses. Any other value is rejected with an error.

payment_due_datestring date

Payment due date in YYYY-MM-DD format. Note: Payment Due Date only applies to miscellaneous expenses. If you pass in a payment_due_date for a miscellaneous credit (i.e., when the is_credit flag is set to true), it will be ignored. A value that is not a valid date is rejected with an error.

next_payment_due_datestring date

The next payment due date in YYYY-MM-DD format. This field only applies to expenses with payment_status_id 2 (Partially Paid). It is ignored for credits and other payment statuses. Responses use next_partial_payment_due_date; either name is accepted as input. If both names are supplied, their values must match. A value that is not a valid date is rejected with an error.

next_partial_payment_due_datestring date

An input alias for next_payment_due_date. The same payment-status rules apply. If both names are supplied, their values must match. A value that is not a valid date is rejected with an error.

payment_notesstring

Notes about the payment for the expense. Note: Payment notes only apply to miscellaneous expenses. If you pass in a payment_notes for a miscellaneous credit (i.e., when the is_credit flag is set to true), it will be ignored.

notesstring

Notes about the miscellaneous expense/credit. Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag, and the text is stored HTML-encoded, so it is returned as HTML (a < b comes back as a < b).

integration_metadata_field_1string

The integration_metadata_field_1 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular miscellaneous expense/credit (e.g., the "external id" of the expense from another system you're integrating with).

integration_metadata_field_2string

The integration_metadata_field_2 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular miscellaneous expense/credit (e.g., the "external id" of the expense from another system you're integrating with).

integration_metadata_field_3string

The integration_metadata_field_3 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular miscellaneous expense/credit (e.g., the "external id" of the expense from another system you're integrating with).

integration_metadata_field_4string

The integration_metadata_field_4 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular miscellaneous expense/credit (e.g., the "external id" of the expense from another system you're integrating with).

integration_metadata_field_5string

The integration_metadata_field_5 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular miscellaneous expense/credit (e.g., the "external id" of the expense from another system you're integrating with).

Response

OK

idinteger
exhibitday_urlstring nullable
descriptionstring nullable
is_creditboolean
amountnumber
notesstring nullable
payment_due_datestring nullable
next_partial_payment_due_datestring nullable
payment_notesstring nullable
event_misc_expense_credit_created_timestampstring date-time
event_misc_expense_credit_last_update_timestampstring date-time
integration_metadata_field_1string nullable
integration_metadata_field_2string nullable
integration_metadata_field_3string nullable
integration_metadata_field_4string nullable
integration_metadata_field_5string nullable

Changes

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