Retrieve a Single Event Miscellaneous Expense/Credit by Id
Method
GET
Endpoint
Sample Object
Retrieves information about a specific event miscellaneous expense/credit (using the "id" parameter).
Parameters
Name
Type
Required?
Details
Description
api_key
String
Yes
id
Number
Yes
Id of the specific event miscellaneous expense/credit that you would like to retrieve.
Find Event Miscellaneous Expense(s)/Credit(s)
Method
GET
Endpoint
Retrieves Event Miscellaneous Expenses/Credits using search filters. At least one filter must be passed in.
Parameters
Name
Type
Required?
Details
Description
api_key
String
Yes
filter_by_event_id
Number
No
Only include miscellaneous expenses/credits for a given event.
filter_by_integration_metadata_field_1
String
No
max length: 3000
Only include event miscellaneous expenses/credits that have their integration_metadata_field_1 property equal to the value you pass in for this parameter. Note: The IntegrationMetadataField1 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).
filter_by_integration_metadata_field_2
String
No
max length: 3000
Only include event miscellaneous expenses/credits that have their integration_metadata_field_2 property equal to the value you pass in for this parameter. Note: The IntegrationMetadataField2 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).
filter_by_integration_metadata_field_3
String
No
max length: 3000
Only include event miscellaneous expenses/credits that have their integration_metadata_field_3 property equal to the value you pass in for this parameter. Note: The IntegrationMetadataField3 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).
filter_by_integration_metadata_field_4
String
No
max length: 3000
Only include event miscellaneous expenses/credits that have their integration_metadata_field_4 property equal to the value you pass in for this parameter. Note: The IntegrationMetadataField4 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).
filter_by_integration_metadata_field_5
String
No
max length: 3000
Only include event miscellaneous expenses/credits that have their integration_metadata_field_5 property equal to the value you pass in for this parameter. Note: The IntegrationMetadataField1 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).
Add a New Event Miscellaneous Expense/Credit
Method
POST
Endpoint
Parameters
Name
Type
Required?
Details
Description
api_key
String
Yes
event_id
Number
Yes
The id of the event you would like to add the miscellaneous expense/credit to.
description
String
Yes
max length: 500
A short description of the miscellaneous expense/credit.
is_credit
Number
No
default: false
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.
amount
Number
No
default: 0.00
Use the amount filed to specify the amount of the miscellaneous expense/credit. The value of this filed 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.
amount_cost_center_breakdown
String
No
The amount_cost_center_breakdown can be used to specify the cost center breakdown for the amount. It must be in JSON array format that represents the cost center id(s) and their corresponding charge. If you choose to specify an amount_cost_center_breakdown, the sum of all the charges in the JSON array MUST equal to the amount field passed in; otherwise, the system will use its best judgement as to how the amount should be split and it may not correctly split the charges across your cost centers in ExhibitDay. You can obtain the Id’s for your cost centers using the following API endpoint: /v1/references/cost_centers. For example, if you are adding an expense in the amount of $300.00 and you want to split the charge as follows: $50.00 charged to “International Operations” (center id 123456), $75.00 charged to “Field Marketing” (cost center id 678910), and the remaining $175.00 not charged to any cost center, pass in 300.00 as the amount, the following JSON array as the amount_cost_center_breakdown: [{"cost_center_id": 123456, "charge": 50.00}, {"cost_center_id": 678910, "charge": 75.00}, {"cost_center_id": null, "charge": 175.00 }]
payment_status_id
String
No
default: 0
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
payment_due_date
String
No
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.
next_payment_due_date
String
No
Due date for the next payment in YYYY-MM-DD format. Note: Payment Due Date only applies to miscellaneous expenses, only if the Payment Status is 'Partially Paid' (payment_status_id $2). If you pass in a payment_due_date for a miscellaneous credit (i.e., when the is_credit flag is set to true) or an expense that has a payment status other than 'Partially Paid', it will be ignored.
payment_notes
String
No
max length: 200
Notes about the payment for the expense. Note: Payment status only applies 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.
notes
String
No
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.
integration_metadata_field_1
String
No
max length: 3000
The IntegrationMetadataField1 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_2
String
No
max length: 3000
The IntegrationMetadataField2 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_3
String
No
max length: 3000
The IntegrationMetadataField3 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_4
String
No
max length: 3000
The IntegrationMetadataField4 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_5
String
No
max length: 3000
The IntegrationMetadataField5 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).
Update an Event Miscellaneous Expense/Credit
Method
PATCH
Endpoint
To update an event miscellaneous expense/credit, only pass in the properties that you want to update. If the update is successful, the message property in the response will contain a list of event miscellaneous expense/credit properties that were actually changed.
Parameters
Name
Type
Required?
Details
Description
api_key
String
Yes
id
Number
Yes
The id of the event miscellaneous expense/credit you would like to update.
description
String
No
max length: 500
A short description of the miscellaneous expense/credit.
is_credit
Number
No
default: false
The is_credit flag indicates whether or not the miscellaneous expense/credit is a credit.
amount
Number
No
default: 0.00
Use the amount filed to specify the amount of the miscellaneous expense/credit. The value of this filed should be a decimal with no currency symbols or commas (e.g., 11250.75).
amount_cost_center_breakdown
String
No
The amount_cost_center_breakdown can be used to specify the cost center breakdown for the amount. It must be in JSON array format that represents the cost center id(s) and their corresponding charge. If you choose to specify an amount_cost_center_breakdown, the sum of all the charges in the JSON array MUST equal to the amount field passed in; otherwise, the system will use its best judgement as to how the amount should be split and it may not be correctly split the charges across your cost centers in ExhibitDay. You can obtain the Id’s for your cost centers using the following API endpoint: /v1/references/cost_centers. For example, if your expense is in the amount of $300.00 and you want to split the charge as follows: $50.00 charged to “International Operations” (center id 123456), $75.00 charged to “Field Marketing” (cost center id 678910), and the remaining $175.00 not charged to any cost center, pass in 300.00 as the amount, the following JSON array as the amount_cost_center_breakdown: [{"cost_center_id": 123456, "charge": 50.00}, {"cost_center_id": 678910, "charge": 75.00}, {"cost_center_id": null, "charge": 175.00 }]
payment_status_id
String
No
default: 0
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
payment_due_date
String
No
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.
next_payment_due_date
String
No
Due date for the next payment in YYYY-MM-DD format. Note: Payment Due Date only applies to miscellaneous expenses, only if the Payment Status is 'Partially Paid' (payment_status_id $2). If you pass in a payment_due_date for a miscellaneous credit (i.e., when the is_credit flag is set to true) or an expense that has a payment status other than 'Partially Paid', it will be ignored.
payment_notes
String
No
max length: 200
Notes about the payment for the expense. Note: Payment status only applies 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.
notes
String
No
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.
integration_metadata_field_1
String
No
max length: 3000
The IntegrationMetadataField1 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_2
String
No
max length: 3000
The IntegrationMetadataField2 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_3
String
No
max length: 3000
The IntegrationMetadataField3 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_4
String
No
max length: 3000
The IntegrationMetadataField4 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_5
String
No
max length: 3000
The IntegrationMetadataField5 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).
Delete an Event Miscellaneous Expense/Credit
Method
DELETE
Endpoint
Permanently deletes an event's miscellaneous expense/credit. It cannot be undone.
Parameters
Name
Type
Required?
Details
Description
api_key
String
Yes
id
Number
Yes
The id of the event miscellaneous expense/credit you would like to delete.