Accounting
Below is a reference to the Endgrate types supported for accounting integrations, and their corresponding default schemas.
accounting-customer
accounting-customerSchema:
{
"addresses":{
"title":"Addresses",
"type":"array",
"description":"The addresses associated with the customer.",
"items":{
"type":"object",
"properties":{
"address_type":{
"enum":[
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title":"Address Type",
"type":"string",
"description":"The type of the address of the customer."
},
"city":{
"title":"City",
"type":"string",
"description":"The city of the address of the customer."
},
"country":{
"title":"Country",
"type":"string",
"description":"The country of the address of the customer."
},
"postal_code":{
"title":"Postal Code",
"type":"string",
"description":"The postal or ZIP code of the address of the customer."
},
"state":{
"title":"State",
"type":"string",
"description":"The state or region of the address of the customer."
},
"street_1":{
"title":"Street 1",
"type":"string",
"description":"Line 1 of street of the address of the customer."
},
"street_2":{
"title":"Street 2",
"type":"string",
"description":"Line 2 of the street of the address of the customer."
}
}
}
},
"customer_name":{
"title":"Customer Name",
"description":"The business name of the customer.",
"type":"string"
},
"email_addresses":{
"title":"Email Addresses",
"type":"array",
"description":"The email addresses associated with the customer.",
"items":{
"type":"object",
"properties":{
"email_address":{
"format":"email",
"title":"Email Address",
"type":"string",
"description":"The email address of the customer."
},
"email_address_type":{
"enum":[
"WORK",
"PERSONAL",
"OTHER"
],
"title":"Email Address Type",
"type":"string",
"description":"The type of the email address of the customer."
}
}
}
},
"phone_numbers":{
"title":"Phone Numbers",
"type":"array",
"description":"The phone numbers associated with the customer.",
"items":{
"type":"object",
"properties":{
"phone_number":{
"title":"Phone Number",
"type":"string",
"description":"The phone number of the customer."
},
"phone_number_type":{
"enum":[
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title":"Phone Number Type",
"type":"string",
"description":"The type of the phone number of the customer."
}
}
}
},
"contact_first_name":{
"title":"Contact First Name",
"type":"string",
"description":"The first name or given name of the primary contact of the customer."
},
"contact_last_name":{
"title":"Contact Last Name",
"type":"string",
"description":"The first name or given name of the primary contact of the customer."
},
"status":{
"enum":[
"ACTIVE",
"INACTIVE",
"UNKNOWN"
],
"title":"Status",
"type":"string",
"description":"The status of the customer."
}
}Example Object:
{
"addresses":[
{
"address_type":"PRIMARY",
"city":"New York",
"country":"USA",
"postal_code":"10001",
"state":"NY",
"street_1":"123 Main St",
"street_2":"Apt 4B"
}
],
"customer_name":"Tech Solutions Inc.",
"email_addresses":[
{
"email_address":"[email protected]",
"email_address_type":"WORK"
}
],
"phone_numbers":[
{
"phone_number":"123-456-7890",
"phone_number_type":"WORK"
}
],
"contact_first_name":"John",
"contact_last_name":"Doe",
"status":"ACTIVE"
}accounting-vendor
accounting-vendorSchema:
{
"addresses":{
"title":"Addresses",
"type":"array",
"description":"The addresses associated with the vendor.",
"items":{
"type":"object",
"properties":{
"address_type":{
"enum":[
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title":"Address Type",
"type":"string",
"description":"The address type of the vendor."
},
"city":{
"title":"City",
"type":"string",
"description":"The city of the address of the vendor."
},
"country":{
"title":"Country",
"type":"string",
"description":"The country of the address of the vendor."
},
"postal_code":{
"title":"Postal Code",
"type":"string",
"description":"The postal or ZIP code of the address of the vendor."
},
"state":{
"title":"State",
"type":"string",
"description":"The state or region of the address of the vendor."
},
"street_1":{
"title":"Street 1",
"type":"string",
"description":"Line 1 of street of the address of the vendor."
},
"street_2":{
"title":"Street 2",
"type":"string",
"description":"Line 2 of the street of the address of the vendor."
}
}
}
},
"vendor_name":{
"title":"Vendor Name",
"description":"The business name of the vendor.",
"type":"string"
},
"email_addresses":{
"title":"Email Addresses",
"type":"array",
"description":"The email addresses associated with the vendor.",
"items":{
"type":"object",
"properties":{
"email_address":{
"format":"email",
"title":"Email Address",
"type":"string",
"description":"The email address of the vendor."
},
"email_address_type":{
"enum":[
"WORK",
"PERSONAL",
"OTHER"
],
"title":"Email Address Type",
"type":"string",
"description":"The type of the email address of the vendor."
}
}
}
},
"phone_numbers":{
"title":"Phone Numbers",
"type":"array",
"description":"The phone numbers associated with the vendor.",
"items":{
"type":"object",
"properties":{
"phone_number":{
"title":"Phone Number",
"type":"string",
"description":"The phone number of the vendor."
},
"phone_number_type":{
"enum":[
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title":"Phone Number Type",
"type":"string",
"description":"The type of the phone number of the vendor."
}
}
}
},
"contact_first_name":{
"title":"Contact First Name",
"type":"string",
"description":"The first name or given name of the primary contact of the vendor."
},
"contact_last_name":{
"title":"Contact Last Name",
"type":"string",
"description":"The first name or given name of the primary contact of the vendor."
},
"status":{
"enum":[
"ACTIVE",
"INACTIVE",
"UNKNOWN"
],
"title":"Status",
"type":"string",
"description":"The status of the vendor."
}
}Example Object:
{
"addresses":[
{
"address_type":"PRIMARY",
"city":"Chicago",
"country":"USA",
"postal_code":"60601",
"state":"IL",
"street_1":"789 Lakeshore Dr",
"street_2":"Suite 1500"
}
],
"vendor_name":"Global Supply Co.",
"email_addresses":[
{
"email_address":"[email protected]",
"email_address_type":"WORK"
}
],
"phone_numbers":[
{
"phone_number":"555-123-4567",
"phone_number_type":"WORK"
}
],
"contact_first_name":"Emily",
"contact_last_name":"Smith",
"status":"ACTIVE"
}accounting-item
accounting-itemSchema:
{
"name":{
"title":"Name",
"type":"string",
"description":"The name of the item."
},
"status":{
"enum":[
"ACTIVE",
"INACTIVE",
"UNKNOWN"
],
"title":"Status",
"type":"string",
"description":"The status of the item."
},
"unit_price":{
"title":"Unit Price",
"type":"number",
"description":"The unit price of the item."
},
"purchase_price":{
"title":"Purchase Price",
"type":"number",
"description":"The purchase price of the item."
}
}Example Object:
{
"name":"Wireless Mouse",
"status":"ACTIVE",
"unit_price":25.99,
"purchase_price":15.00
}accounting-purchase_order
accounting-purchase_orderSchema:
{
"vendor_id":{
"title":"Vendor ID",
"type":"string",
"description":"The unique identifier of the vendor linked to the purchase order."
},
"issue_date":{
"title":"Issue Date",
"type":"string",
"format":"date-time",
"description":"The issue date of the purchase order."
},
"status":{
"enum":[
"OPEN",
"CLOSED",
"PENDING_BILL",
"UNKNOWN"
],
"title":"Status",
"type":"string",
"description":"The status of the purchase order."
},
"document_number":{
"title":"Document Number",
"type":"string",
"description":"The buyer facing document number of the purchase order."
},
"memo":{
"title":"Memo",
"type":"string",
"description":"The memo of the purchase order."
},
"tax_amount":{
"title":"Tax Amount",
"type":"number",
"description":"The total tax amount applied to the purchase order."
},
"total_amount":{
"title":"Total Amount",
"type":"number",
"description":"The total payment amount, including tax, of the purchase order."
},
"line_items":{
"title":"Line Items",
"type":"array",
"description":"The line items associated with the purchase order.",
"items":{
"type":"object",
"properties":{
"item_name":{
"title":"Item Name",
"type":"string",
"description":"The name of the purchase order line item."
},
"description":{
"title":"Description",
"type":"string",
"description":"The description of the purchase order line item."
},
"quantity":{
"title":"Quantity",
"type":"number",
"description":"The quantity of the purchase order line item."
},
"unit_price":{
"title":"Unit Price",
"type":"number",
"description":"The unit price of the purchase order line item."
},
"tax_amount":{
"title":"Tax Amount",
"type":"number",
"description":"The tax amount of the purchase order line item."
},
"total_amount":{
"title":"Total Amount",
"type":"number",
"description":"The total amount, including tax, of the purchase order line item."
}
}
}
}
}Example Object:
{
"vendor_id":"VND12345",
"issue_date":"2024-06-01 10:00:00",
"status":"OPEN",
"document_number":"PO987654",
"memo":"Urgent order for new office supplies",
"tax_amount":45.00,
"total_amount":245.00,
"line_items":[
{
"item_name":"Desk Chair",
"description":"Ergonomic office chair with lumbar support",
"quantity":2,
"unit_price":100.00,
"tax_amount":20.00,
"total_amount":220.00
}
]
}accounting-sales_order
accounting-sales_orderSchema:
{
"customer_id":{
"title":"Customer ID",
"type":"string",
"description":"The unique identifier of the customer linked to the sales order."
},
"issue_date":{
"title":"Issue Date",
"type":"string",
"format":"date-time",
"description":"The issue date of the sales order."
},
"status":{
"enum":[
"OPEN",
"CLOSED",
"PENDING_APPROVAL",
"UNKNOWN"
],
"title":"Status",
"type":"string",
"description":"The status of the sales order."
},
"document_number":{
"title":"Document Number",
"type":"string",
"description":"The buyer facing document number of the sales order."
},
"memo":{
"title":"Memo",
"type":"string",
"description":"The memo of the sales order."
},
"tax_amount":{
"title":"Tax Amount",
"type":"number",
"description":"The total tax amount applied to the sales order."
},
"total_amount":{
"title":"Total Amount",
"type":"number",
"description":"The total payment amount, including tax, of the sales order."
},
"line_items":{
"title":"Line Items",
"type":"array",
"description":"The line items associated with the sales order.",
"items":{
"type":"object",
"properties":{
"item_name":{
"title":"Item Name",
"type":"string",
"description":"The name of the sales order line item."
},
"description":{
"title":"Description",
"type":"string",
"description":"The description of the sales order line item."
},
"quantity":{
"title":"Quantity",
"type":"number",
"description":"The quantity of the sales order line item."
},
"unit_price":{
"title":"Unit Price",
"type":"number",
"description":"The unit price of the purchase order line item."
},
"tax_amount":{
"title":"Tax Amount",
"type":"number",
"description":"The tax amount of the purchase order line item."
},
"total_amount":{
"title":"Total Amount",
"type":"number",
"description":"The total payment amount, including tax, of the purchase order line item."
}
}
}
}
}Example Object:
{
"customer_id":"CUST56789",
"issue_date":"2024-06-09 12:00:00",
"status":"PENDING_APPROVAL",
"document_number":"SO123456",
"memo":"New order for summer inventory",
"tax_amount":35.00,
"total_amount":335.00,
"line_items":[
{
"item_name":"Sunglasses",
"description":"Polarized sunglasses with UV protection",
"quantity":10,
"unit_price":20.00,
"tax_amount":10.00,
"total_amount":210.00
}
]
}accounting-invoice
accounting-invoice{
"customer_id": {
"title": "Customer ID",
"type": "string",
"description": "The unique identifier of the customer linked to the invoice."
},
"due_date": {
"title": "Due Date",
"type": "string",
"format": "date-time",
"description": "The due date of the invoice."
},
"issue_date": {
"title": "Issue Date",
"type": "string",
"format": "date-time",
"description": "The issue date of the invoice."
},
"transaction_date": {
"title": "Transaction Date",
"type": "string",
"format": "date-time",
"description": "The transaction logged date of the invoice."
},
"status": {
"enum": [
"OPEN",
"PARTIALLY_PAID",
"PAID",
"VOID",
"DRAFT",
"SUBMITTED",
"UNKNOWN"
],
"title": "Status",
"type": "string",
"description": "The status of the invoice."
},
"document_number": {
"title": "Document Number",
"type": "string",
"description": "The seller facing document number of the invoice."
},
"memo": {
"title": "Memo",
"type": "string",
"description": "The memo of the invoice."
},
"amount_due": {
"title": "Amount Due",
"type": "number",
"description": "The current amount due (remaining balance) on the invoice."
},
"tax_amount": {
"title": "Tax Amount",
"type": "number",
"description": "The total tax amount applied to the invoice."
},
"discount_amount": {
"title": "Discount Amount",
"type": "number",
"description": "The total discount amount applied to the invoice."
},
"total_amount": {
"title": "Total Amount",
"type": "number",
"description": "The total amount due on the invoice."
},
"line_items": {
"title": "Line Items",
"type": "array",
"description": "The line items associated with the invoice.",
"items": {
"type": "object",
"properties": {
"item_id": {
"title": "Item ID",
"type": "string",
"description": "The ID of the invoice line item."
},
"item_name": {
"title": "Item Name",
"type": "string",
"description": "The name of the invoice line item."
},
"description": {
"title": "Description",
"type": "string",
"description": "The description of the invoice line item."
},
"quantity": {
"title": "Quantity",
"type": "number",
"description": "The quantity of the invoice line item."
},
"unit_price": {
"title": "Unit Price",
"type": "number",
"description": "The unit price of the invoice line item."
},
"tax_code": {
"title": "Tax Code",
"type": "string",
"description": "The tax code of the invoice line item."
},
"tax_amount": {
"title": "Tax Amount",
"type": "number",
"description": "The tax amount of the invoice line item."
},
"total_amount": {
"title": "Total Amount",
"type": "number",
"description": "The total payment amount, including tax, of the invoice line item."
}
}
}
}
}Example Object:
{
"customer_id":"CUST12345",
"due_date":"2024-07-01 00:00:00",
"issue_date":"2024-06-01 00:00:00",
"transaction_date":"2024-06-01 00:00:00",
"status":"PARTIALLY_PAID",
"document_number":"INV987654",
"memo":"Invoice for June purchases",
"amount_due":150.00,
"tax_amount":30.00,
"discount_amount":10.00,
"total_amount":190.00,
"line_items":[
{
"item_id": "123",
"item_name":"Laptop",
"description":"15-inch laptop with 16GB RAM",
"quantity":1,
"unit_price":1000.00,
"tax_code": "CA",
"tax_amount":100.00,
"total_amount":1100.00
}
]
}Updated 13 days ago