Accounting
Below is a reference to the Endgrate types supported for accounting integrations, and their corresponding default schemas.
accounting-address
accounting-addressSchema:
{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string",
"description":"The type of the address (primary, billing, etc.)"
},
"city": {
"title": "City",
"type": "string",
"description": "The address type."
},
"country": {
"title": "Country",
"type": "string",
"description": "The address's country."
},
"postal_code": {
"title": "Postal Code",
"type": "string",
"description": "The address's postal or ZIP code."
},
"state": {
"title": "State",
"type": "string",
"description": "The address's state or region."
},
"street_1": {
"title": "Street 1",
"type": "string",
"description": "Line 1 of the address's street."
},
"street_2": {
"title": "Street 2",
"type": "string",
"description": "Line 2 of the address's street."
}
}
Example Object:
{
"id": "123",
"address_type": "OTHER",
"city": "New York",
"country": "US",
"postal_code": "10001",
"state": "New York",
"street_1": "20 W 34th St",
"street_2": "Apt 101"
}
accounting-company
accounting-companySchema:
{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"addresses": {
"items": {
"properties": {
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string",
"description":"The type of the address (primary, billing, etc.)"
},
"city": {
"title": "City",
"type": "string",
"description": "The address type."
},
"country": {
"title": "Country",
"type": "string",
"description": "The address's country."
},
"postal_code": {
"title": "Postal Code",
"type": "string",
"description": "The address's postal or ZIP code."
},
"state": {
"title": "State",
"type": "string",
"description": "The address's state or region."
},
"street_1": {
"title": "Street 1",
"type": "string",
"description": "Line 1 of the address's street."
},
"street_2": {
"title": "Street 2",
"type": "string",
"description": "Line 2 of the address's street."
}
},
"type": "object"
},
"title": "Addresses",
"type": "array"
},
"description": {
"title": "Description",
"type": "string",
"description": "A brief description of the company."
},
"industry": {
"title": "Industry",
"description": "The field or industry that the company operates within.",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the company.",
"type": "string"
},
"number_of_employees": {
"title": "Number of Employees",
"type": "number",
"description": "The number of employees at this company."
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string",
"description": "The phone number associated with this company."
},
"phone_number_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Number Type",
"type": "string",
"description": "The type associated with this phone number (work, personal, etc.)"
}
},
"type": "object"
},
"title": "Phone Numbers",
"type": "array"
},
"urls": {
"format": "uri",
"title": "Website",
"type": "string",
"description": "The company's website."
},
"currency": {
"title": "Currency",
"type": "string",
"description": "The currency set in the company's accounting platform."
},
"fiscal_year_end_day": {
"title": "Fiscal Year End Day",
"type": "number",
"description": "The company's fiscal year end day."
},
"fiscal_year_end_month": {
"title": "Fiscal Year End Month",
"type": "number",
"description": "The company's fiscal year end month."
},
"tax_number": {
"title": "Tax Number",
"type": "string",
"description": "The company's tax number."
},
"legal_name": {
"title": "Legal Name",
"type": "string",
"description": "The company's legal name."
}
}
Example Object:
{
"id": "123",
"addresses": [
{
"address_type": "PRIMARY",
"city": "New York City",
"country": "United States",
"postal_code": "10001",
"state": "New York",
"street_1": "20 W 34th St",
"street_2": "Apt 101"
}
],
"description": "100+ Integrations, One Connection.",
"industry": "Information Technology",
"name": "Endgrate",
"number_of_employees": 50,
"phone_numbers": [
{
"phone_number": "+1 631-555-1234",
"phone_number_type": "WORK"
}
],
"website": "https://endgrate.com/",
"currency": "USD",
"fiscal_year_end_day": 31,
"fiscal_year_end_month": 12,
"tax_number": "12-3456789",
"legal_name": "Endgrate"
}
accounting-contact
accounting-contactSchema:
{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"addresses": {
"items": {
"properties": {
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string",
"description":"The type of the address (primary, billing, etc.)"
},
"city": {
"title": "City",
"type": "string",
"description": "The address type."
},
"country": {
"title": "Country",
"type": "string",
"description": "The address's country."
},
"postal_code": {
"title": "Postal Code",
"type": "string",
"description": "The address's postal or ZIP code."
},
"state": {
"title": "State",
"type": "string",
"description": "The address's state or region."
},
"street_1": {
"title": "Street 1",
"type": "string",
"description": "Line 1 of the address's street."
},
"street_2": {
"title": "Street 2",
"type": "string",
"description": "Line 2 of the address's street."
}
},
"type": "object"
},
"title": "Addresses",
"type": "array"
},
"balance": {
"title": "Balance",
"description": "The contact's remaining balance.",
"type": "number"
},
"company_name": {
"title": "Company Name",
"description": "The name of the company associated with this contact.",
"type": "string"
},
"contact_type": {
"enum": [
"SUPPLIER",
"COMPANY",
"CUSTOMER"
],
"title": "Contact Type",
"type": "string",
"description": "The type of contact (supplier, company, or customer.)"
},
"created_date": {
"format": "date-time",
"title": "Creation Date",
"type": "string",
"description": "The date the object was created."
},
"currency": {
"title": "Currency",
"type": "string",
"description": "The currency the contact's transactions are in."
},
"email_addresses": {
"items": {
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string",
"description": "The contact's email address."
},
"email_address_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Address Type",
"type": "string",
"description": "The type of the contact's email address (work, personal, or other.)"
}
},
"type": "object"
},
"title": "Email Addresses",
"type": "array"
},
"first_name": {
"title": "First Name",
"type": "string",
"description": "The first name or given name of the contact."
},
"is_active": {
"title": "Active",
"type": "boolean",
"description": "If true, this contact is active in the accounting system."
},
"last_name": {
"title": "Last Name",
"type": "string",
"description": "The last name or family name of the contact."
},
"modification_date": {
"format": "date-time",
"title": "Modification Date",
"type": "string",
"description": "The date the contact was last modified."
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string",
"description": "The phone number associated with this company."
},
"phone_number_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Number Type",
"type": "string",
"description": "The type associated with this phone number (work, personal, etc.)"
}
},
"type": "object"
},
"title": "Phone Numbers",
"type": "array"
},
"tax_number": {
"title": "Tax Number",
"type": "string",
"description": "The contact's tax number."
}
}
Example Object:
{
"id": "123",
"addresses": [
{
"address_type": "PRIMARY",
"city": "New York",
"country": "United States",
"postal_code": "10001",
"state": "NY",
"street_1": "20 W 34th St",
"street_2": "Apt 101"
}
],
"balance": 1000,
"company_name": "Endgrate",
"contact_type": "SUPPLIER",
"created_date": "2024-01-01 00:00:00",
"currency": "USD",
"email_addresses": [
{
"email_address": "[email protected]",
"email_address_type": "WORK"
}
],
"first_name": "John",
"is_active": true,
"last_name": "Doe",
"modification_date": "2024-01-01 00:00:00",
"phone_numbers": [
{
"phone_number": "+1 631-555-1234",
"phone_type": "HOME"
}
],
"tax_number": "12-3456789"
}
accounting-contact_people
accounting-contact_peopleSchema:
{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"addresses": {
"items": {
"properties": {
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string",
"description":"The type of the address (primary, billing, etc.)"
},
"city": {
"title": "City",
"type": "string",
"description": "The address type."
},
"country": {
"title": "Country",
"type": "string",
"description": "The address's country."
},
"postal_code": {
"title": "Postal Code",
"type": "string",
"description": "The address's postal or ZIP code."
},
"state": {
"title": "State",
"type": "string",
"description": "The address's state or region."
},
"street_1": {
"title": "Street 1",
"type": "string",
"description": "Line 1 of the address's street."
},
"street_2": {
"title": "Street 2",
"type": "string",
"description": "Line 2 of the address's street."
}
},
"type": "object"
},
"title": "Addresses",
"type": "array"
},
"email_addresses": {
"items": {
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string",
"description": "The contact's email address."
},
"email_address_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Address Type",
"type": "string",
"description": "The type of the contact's email address (work, personal, or other.)"
}
},
"type": "object"
},
"title": "Email Addresses",
"type": "array"
},
"first_name": {
"title": "First Name",
"type": "string",
"description": "The first name or given name of a contact."
},
"is_main_contact": {
"title": "Main Contact",
"type": "boolean",
"description": "If true, this contact is the main contact of a company."
},
"is_preferred_contact": {
"title": "Preferred Contact",
"type": "boolean",
"description": "If true, this contact is the preferred contact for a company."
},
"job_title": {
"title": "Job Title",
"description": "The position that an individual works in.",
"type": "string"
},
"last_name": {
"title": "Last Name",
"description": "The last name or family name of the contact.",
"type": "string"
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string",
"description": "The phone number associated with this company."
},
"phone_number_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Number Type",
"type": "string",
"description": "The type associated with this phone number (work, personal, etc.)"
}
},
"type": "object"
},
"title": "Phone Numbers",
"type": "array"
}
}
Example Object:
{
"id": "123",
"addresses": [
{
"address_type": "PRIMARY",
"city": "New York City",
"country": "United States",
"postal_code": "",
"state": "New York",
"street_1": "20 W 34th St",
"street_2": "Apt 101"
}
],
"email_addresses": [
{
"email_address": "[email protected]",
"email_address_type": "WORK"
}
],
"first_name": "John",
"is_main_contact": true,
"is_preferred_contact": true,
"job_title": "Software Engineer",
"last_name": "Doe",
"phone_numbers": [
{
"phone_number": "+1 631-555-1234",
"phone_number_type": "WORK"
}
]
}
accounting-invoice
accounting-invoiceSchema:
{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"balance": {
"title": "Balance",
"description": "The remaining balance of the invoice.",
"type": "number"
},
"currency": {
"title": "Currency",
"description": "The invoice's currency.",
"type": "string"
},
"due_date": {
"format": "date-time",
"title": "Due Date",
"description": "The invoice's due date.",
"type": "string"
},
"exchange_rate": {
"title": "Exchange Rate",
"type": "number",
"description": "The invoice's exchange rate."
},
"invoice_type": {
"enum": [
"ACCOUNTS_RECEIVABLE",
"ACCOUNTS_PAYABLE"
],
"title": "Invoice Type",
"type": "string",
"description": "Whether the invoice is an accounts receivable or accounts payable."
},
"issue_date": {
"format": "date-time",
"title": "Issue Date",
"type": "string",
"description": "The invoice's issue date."
},
"line_items": {
"items": {
"properties": {
"currency": {
"title": "Currency",
"type": "string",
"description": "The line item's currency."
},
"description": {
"title": "Description",
"type": "string",
"description": "The line item's description."
},
"exchange_rate": {
"title": "Exchange Rate",
"type": "number",
"description": "The line item's exchange rate."
},
"item_name": {
"title": "Item Name",
"type": "string",
"description": "The name of the line item."
},
"quantity": {
"title": "Quantity",
"type": "number",
"description": "The line item's quantity."
},
"total_amount": {
"title": "Total Amount",
"type": "number",
"description": "The line item's total amount."
},
"unit_price": {
"title": "Unit Price",
"type": "number",
"description": "The line item's unit price."
}
},
"type": "object"
},
"title": "Line Items",
"type": "array",
"description": "An itemized record of goods and/or services sold to a customer."
},
"memo": {
"title": "Memo",
"description": "The invoice's notes.",
"type": "string"
},
"number": {
"title": "Number",
"type": "string",
"description": "The invoice's number."
},
"paid_on_date": {
"format": "date-time",
"title": "Paid On Date",
"type": "string",
"description": "The invoice's paid date."
},
"status": {
"enum": [
"PAID",
"DRAFT",
"SUBMITTED",
"PARTIALLY_PAID",
"OPEN"
],
"title": "Status",
"type": "string",
"description": "The status of the invoice."
},
"sub_total": {
"title": "Sub Total",
"description": "The amount of money paid before taxes.",
"type": "number"
},
"total_amount": {
"title": "Total Amount",
"type": "number",
"description": "The invoice's total amount."
},
"total_discount": {
"title": "Total Discount",
"type": "number",
"description": "The total discounts applied to the total cost."
},
"total_tax_amount": {
"title": "Total Tax Amount",
"type": "number",
"description": "The total amount being paid in taxes."
},
"customer_id": {
"title": "Customer ID",
"type": "string",
"description": "The customer's unique identifier."
}
}
Example Object:
{
"id": "123",
"balance": 1000,
"currency": "USD",
"due_date": "2024-01-02 00:00:00",
"exchange_rate": 0.5,
"invoice_type": "ACCOUNTS_RECEIVABLE",
"issue_date": "2024-01-01 00:00:00",
"line_items": [
{
"currency": "USD",
"description": "Test Description",
"exchange_rate": 0.97,
"item_name": "Test Item",
"quantity": 1000,
"total_amount": 1000,
"unit_price": 50
}
],
"memo": "Memo Test",
"number": "EG12345678",
"paid_on_date": "2024-01-02 00:00:00",
"status": "PAID",
"sub_total": 1000,
"total_amount": 1000,
"total_discount": 50,
"total_tax_amount": 50,
"customer_id": "123"
}
accounting-payment
accounting-payment{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"applied_to_lines": {
"description": "The line items that this payment is applied to.",
"properties": {
"invoice_id": {
"title": "Invoice ID",
"type":"string",
"description": "The invoice ID that this payment is associated with."
},
"applied_amount": {
"title": "Applied Amount",
"type": "number",
"description": "The amount being applied to the transaction."
},
"applied_date": {
"format": "date-time",
"title": "Applied Date",
"type": "string",
"description": "The date the payment portion is applied."
}
},
"title": "Lines Applied To",
"type": "object"
},
"currency": {
"title": "Currency",
"type": "string",
"description": "The payment's currency."
},
"exchange_rate": {
"title": "Exchange Rate",
"type": "string",
"description": "The payment's exchange rate."
},
"total_amount": {
"title": "Total Amount",
"type": "number",
"description": "The total amount of money being paid to the supplier, or customer, after taxes."
},
"company_id": {
"title": "Company ID",
"type": "string",
"description": "The unique identifier of the company the payment belongs to."
},
"contact_id": {
"title": "Contact ID",
"type": "string",
"description": "The unique identifier of the supplier or customer involved in the payment."
},
"transaction_date": {
"format": "date-time",
"title": "Transaction Date",
"type": "string",
"description": "The payment's transaction date."
}
}
Example Object:
{
"id": "123",
"applied_to_lines": {
"invoice_id": "456",
"applied_amount": 50,
"applied_date": "2024-02-28 12:00:00"
},
"currency": "USD",
"exchange_rate": "1.23",
"company_id": "123",
"contact_id": "456",
"total_amount": 100,
"transaction_date": "2024-02-28 12:00:00"
}
accounting-product
accounting-productSchema:
{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"company_id": {
"type": "string",
"title": "Company ID",
"description": "The unique identifier of the company the item belongs to."
},
"purchase_price": {
"type":"number",
"title": "Purchase Price",
"description": "The price at which the item is purchased from a vendor."
},
"unit_price": {
"type": "number",
"title": "Unit Price",
"description": "The item's unit price."
},
"quantity": {
"type": "number",
"title": "Quantity",
"description": "The quantity on hand for the item."
},
"active": {
"type": "boolean",
"title": "Active",
"description":"An indicator of whether or not the item is active in the accounting software."
},
"name": {
"type": "string",
"title": "Name",
"description": "The item's name."
},
"description": {
"type": "string",
"title": "Description",
"description": "The item's description."
}
}
Example Object:
{
"id": "123",
"company_id": "456",
"purchase_price": 19.99,
"unit_price": 24.99,
"quantity": 15,
"active": true,
"name": "Endgrate",
"description": "Test item description."
}
accounting-purchase_order
accounting-purchase_orderSchema:
{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"item_id": {
"type": "string",
"title": "Item ID",
"description": "The unique identifier of the product associated with this purchase order."
},
"addresses": {
"items": {
"properties": {
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string",
"description":"The type of the address (primary, billing, etc.)"
},
"city": {
"title": "City",
"type": "string",
"description": "The address type."
},
"country": {
"title": "Country",
"type": "string",
"description": "The address's country."
},
"postal_code": {
"title": "Postal Code",
"type": "string",
"description": "The address's postal or ZIP code."
},
"state": {
"title": "State",
"type": "string",
"description": "The address's state or region."
},
"street_1": {
"title": "Street 1",
"type": "string",
"description": "Line 1 of the address's street."
},
"street_2": {
"title": "Street 2",
"type": "string",
"description": "Line 2 of the address's street."
}
},
"type": "object"
},
"title": "Addresses",
"type": "array"
},
"currency": {
"title": "Currency",
"type": "string",
"description": "The purchase order's currency."
},
"exchange_rate": {
"title": "Exchange Rate",
"type": "number",
"description": "The purchase order's exchange rate."
},
"email_addresses": {
"items": {
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string",
"description": "The contact's email address."
},
"email_address_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Address Type",
"type": "string",
"description": "The type of the contact's email address (work, personal, or other.)"
}
},
"type": "object"
},
"title": "Email Addresses",
"type": "array"
},
"line_items": {
"items": {
"properties": {
"currency": {
"title": "Currency",
"type": "string",
"description": "The line item's currency."
},
"description": {
"title": "Description",
"type": "string",
"description": "A description of the good being purchased."
},
"exchange_rate": {
"title": "Exchange Rate",
"type": "number",
"description": "The line item's exchange rate."
},
"item_name": {
"title": "Item Name",
"type": "string",
"description": "The name of the line item."
},
"quantity": {
"title": "Quantity",
"type": "number",
"description": "The line item's quantity."
},
"total_amount": {
"title": "Total Amount",
"type": "number",
"description": "The line item's total amount including tax."
},
"tax_amount": {
"title": "Tax Amount",
"type": "number",
"description": "The line item's tax amount."
},
"unit_price": {
"title": "Unit Price",
"type": "number",
"description": "The line item's unit price."
}
},
"type": "object"
},
"title": "Line Items",
"type": "array"
},
"transaction_date": {
"format": "date-time",
"title": "Transaction Date",
"description": "The date of the transaction.",
"type": "string"
},
"vendor_name": {
"title": "Vendor Name",
"type": "string",
"description": "The name of the party fulfilling the purchase order."
},
"memo": {
"title": "Memo",
"type": "string",
"description": "A memo attached to the purchase order."
},
"vendor_id": {
"title": "Vendor ID",
"type": "string",
"description": "The unique identifier of the party fulfilling the purchase order."
},
"customer_id": {
"title": "Customer ID",
"type": "string",
"description": "The unique identifier of the contact making the purchase order."
},
"delivery_date": {
"format": "date-time",
"type": "string",
"title": "Delivery Date",
"description": "The purchase order's delivery date."
},
"purchase_order_number": {
"type": "string",
"title": "Purchase Order Number",
"description": "The human-readable number of the purchase order."
},
"issue_date": {
"format": "date-time",
"type": "string",
"title": "Issue Date",
"description": "The purchase order's issue date."
},
"status": {
"type": "string",
"enum": [
"DRAFT", "SUBMITTED", "AUTHORIZED", "BILLED", "DELETED"
],
"title": "Status",
"description": "The purchase order's status."
}
}
Example Object:
{
"id": "123",
"item_id": "456",
"addresses": [
{
"address_type": "PRIMARY",
"city": "New York City",
"country": "United States",
"postal_code": "10001",
"state": "New York",
"street_1": "20 W 34th St",
"street_2": "Apt 101"
}
],
"currency": "USD",
"exchange_rate": 1,
"email_addresses": [
{
"email_address": "[email protected]",
"email_type": "WORK"
}
],
"line_items": [
{
"currency": "USD",
"description": "For offline and advanced transfers.",
"exchange_rate": 1,
"item_name": "Advanced Endgrate Integration",
"quantity": 1,
"total_amount": 1750,
"tax_amount": 0,
"unit_price": 1750
}
],
"transaction_date": "2024-01-01 00:00:00",
"vendor_name": "Endgrate",
"memo": "Integration services",
"vendor_id": "123",
"customer_id": "456",
"delivery_date": "2024-01-01 00:00:00",
"purchase_order_number": "EG12345678",
"issue_date": "2024-01-01 00:00:00",
"status": "SUBMITTED"
}
Updated about 1 month ago