{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/your-tenant.craterinvoice.com\/" } ], "info": { "name": "Crater Invoice API Documentation", "_postman_id": "2e661b9d-433c-415f-b2fb-b9aa87dde300", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Auth", "description": "Authentication endpoints", "item": [ { "name": "Get Authentication token", "request": { "url": { "host": "{{baseUrl}}", "path": "oauth\/token", "query": [], "raw": "{{baseUrl}}\/oauth\/token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"grant_type\":\"client_credentials\",\"client_id\":\"your-client-id\",\"client_secret\":\"your-client-secret\"}" }, "description": "This endpoint allows you to get the bearer token required for authentication of all protected endpoints", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"token_type\":\"Bearer\",\"expires_in\":31536000,\"access_token\":\"Your-bearer-token\"}", "name": "" } ] } ] }, { "name": "Businesses", "description": "\nAPI Endpoints for managing businesses", "item": [ { "name": "List all businesses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/businesses", "query": [ { "key": "limit", "value": "6", "description": "A limit on the number of businesses to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "9", "description": "Number of page (For Pagination).", "disabled": false }, { "key": "name", "value": "error", "description": "Filter records by name", "disabled": false }, { "key": "business_type", "value": "vel", "description": "Filter records by business_type", "disabled": false }, { "key": "email", "value": "beatae", "description": "Filter records by email", "disabled": false }, { "key": "phone", "value": "qui", "description": "Filter records by phone", "disabled": false }, { "key": "contact_first_name", "value": "sapiente", "description": "Filter records by contact_first_name", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/businesses?limit=6&page=9&name=error&business_type=vel&email=beatae&phone=qui&contact_first_name=sapiente" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of your businesses." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":269,\"name\":\"Dare Inc\",\"website\":null,\"phone\":null,\"email\":\"marilie.robel@yahoo.com\",\"logo\":null,\"unique_hash\":\"8EIbhbxxp94lNCX0iOZt\",\"profile_completed\":null,\"slug\":\"dare-inc\",\"contact_first_name\":\"Kaylee\",\"contact_last_name\":\"McCullough\",\"charges_enabled\":null,\"payouts_enabled\":null,\"details_submitted\":null,\"business_type\":\"company\",\"requirements\":null,\"created_at\":1667663245},{\"id\":270,\"name\":\"Frami and Sons\",\"website\":null,\"phone\":null,\"email\":\"cristal51@gmail.com\",\"logo\":null,\"unique_hash\":\"2IiJQMSIvxFDeV6JCK1C\",\"profile_completed\":null,\"slug\":\"frami-and-sons\",\"contact_first_name\":\"Katarina\",\"contact_last_name\":\"VonRueden\",\"charges_enabled\":null,\"payouts_enabled\":null,\"details_submitted\":null,\"business_type\":\"company\",\"requirements\":null,\"created_at\":1667663245}]}", "name": "0" } ] }, { "name": "Create a business", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/businesses", "query": [], "raw": "{{baseUrl}}\/api\/v2\/businesses" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Crater Invoice\",\"contact_first_name\":\"rerum\",\"contact_last_name\":\"aut\",\"business_type\":\"porro\",\"email\":\"tempora\",\"address\":{\"state\":\"California\",\"city\":\"Los Angeles\",\"address_street_1\":\"Address 1\",\"address_street_2\":\"Address 2\",\"zip\":\"91504\",\"phone\":\"123-123-123\",\"website\":\"https:\\\/\\\/craterapp.com\"}}" }, "description": "" }, "response": [] }, { "name": "Retrieve a business", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/businesses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/businesses\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves a Business object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":271,\"name\":\"Bednar LLC\",\"website\":null,\"phone\":null,\"email\":\"roob.maxwell@yahoo.com\",\"logo\":null,\"unique_hash\":\"V1QZrlqQRiLFgXhJbiJK\",\"profile_completed\":null,\"slug\":\"bednar-llc\",\"contact_first_name\":\"Cordia\",\"contact_last_name\":\"Spencer\",\"charges_enabled\":null,\"payouts_enabled\":null,\"details_submitted\":null,\"business_type\":\"company\",\"requirements\":null,\"created_at\":1667663245}}", "name": "0" } ] }, { "name": "Update a business", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/businesses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/businesses\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the business." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Crater Invoice\",\"contact_first_name\":\"consectetur\",\"contact_last_name\":\"enim\",\"business_type\":\"vero\",\"email\":\"id\",\"address\":{\"state\":\"California\",\"city\":\"Los Angeles\",\"address_street_1\":\"Address 1\",\"address_street_2\":\"Address 2\",\"zip\":\"91504\",\"phone\":\"123-123-123\",\"website\":\"https:\\\/\\\/craterapp.com\"}}" }, "description": "" }, "response": [] }, { "name": "Delete Business", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/businesses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/businesses\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the business." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Delete a business." }, "response": [] } ] }, { "name": "Current Business", "description": "\nAPI Endpoints for managing currently active business", "item": [ { "name": "Active Business", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/business", "query": [], "raw": "{{baseUrl}}\/api\/v2\/business" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves currently active Business object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":272,\"name\":\"Leffler-Kreiger\",\"website\":null,\"phone\":null,\"email\":\"verla36@ernser.com\",\"logo\":null,\"unique_hash\":\"xgNZfL6vGi64k22fbtm9\",\"profile_completed\":null,\"slug\":\"leffler-kreiger\",\"contact_first_name\":\"Ethan\",\"contact_last_name\":\"Lindgren\",\"charges_enabled\":null,\"payouts_enabled\":null,\"details_submitted\":null,\"business_type\":\"company\",\"requirements\":null,\"created_at\":1667663246}}", "name": "0" } ] }, { "name": "Update current business", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/business", "query": [], "raw": "{{baseUrl}}\/api\/v2\/business" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Crater Invoice\",\"contact_first_name\":\"sit\",\"contact_last_name\":\"et\",\"business_type\":\"aperiam\",\"email\":\"consequuntur\",\"address\":{\"state\":\"California\",\"city\":\"Los Angeles\",\"address_street_1\":\"Address 1\",\"address_street_2\":\"Address 2\",\"zip\":\"91504\",\"phone\":\"123-123-123\",\"website\":\"https:\\\/\\\/craterapp.com\"}}" }, "description": "" }, "response": [] }, { "name": "Upload business logo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/business\/upload-logo", "query": [], "raw": "{{baseUrl}}\/api\/v2\/business\/upload-logo" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"business_logo\":\"Logo.png\"}" }, "description": "" }, "response": [] }, { "name": "Get business settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/business\/settings", "query": [], "raw": "{{baseUrl}}\/api\/v2\/business\/settings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"settings\":[\"currency\",\"language\"]}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Update business settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/business\/settings", "query": [], "raw": "{{baseUrl}}\/api\/v2\/business\/settings" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"invoice_business_address_format\":\"
{BUSINESS_ADDRESS_STREET_1}<\\\/p>
{BUSINESS_ADDRESS_STREET_2}<\\\/p>
{BUSINESS_CITY} {BUSINESS_STATE}<\\\/p>
{BUSINESS_COUNTRY} {BUSINESS_ZIP_CODE}<\\\/p>
{BUSINESS_PHONE}<\\\/p>\",\"invoice_shipping_address_format\":\"
{SHIPPING_ADDRESS_STREET_1}<\\\/p>
{SHIPPING_ADDRESS_STREET_2}<\\\/p>
{SHIPPING_CITY} {SHIPPING_STATE}<\\\/p>
{SHIPPING_COUNTRY} {SHIPPING_ZIP_CODE}<\\\/p>
{SHIPPING_PHONE}<\\\/p>\",\"invoice_billing_address_format\":\"
{BILLING_ADDRESS_STREET_1}<\\\/p>
{BILLING_ADDRESS_STREET_2}<\\\/p>
{BILLING_CITY} {BILLING_STATE}<\\\/p>
{BILLING_COUNTRY} {BILLING_ZIP_CODE}<\\\/p>
{BILLING_PHONE}<\\\/p>\",\"estimate_business_address_format\":\"
{BUSINESS_ADDRESS_STREET_1}<\\\/p>
{BUSINESS_ADDRESS_STREET_2}<\\\/p>
{BUSINESS_CITY} {BUSINESS_STATE}<\\\/p>
{BUSINESS_COUNTRY} {BUSINESS_ZIP_CODE}<\\\/p>
{BUSINESS_PHONE}<\\\/p>\",\"estimate_shipping_address_format\":\"
{SHIPPING_ADDRESS_STREET_1}<\\\/p>
{SHIPPING_ADDRESS_STREET_2}<\\\/p>
{SHIPPING_CITY} {SHIPPING_STATE}<\\\/p>
{SHIPPING_COUNTRY} {SHIPPING_ZIP_CODE}<\\\/p>
{SHIPPING_PHONE}<\\\/p>\",\"estimate_billing_address_format\":\"
{BILLING_ADDRESS_STREET_1}<\\\/p>
{BILLING_ADDRESS_STREET_2}<\\\/p>
{BILLING_CITY} {BILLING_STATE}<\\\/p>
{BILLING_COUNTRY} {BILLING_ZIP_CODE}<\\\/p>
{BILLING_PHONE}<\\\/p>\",\"payment_business_address_format\":\"
{BUSINESS_ADDRESS_STREET_1}<\\\/p>
{BUSINESS_ADDRESS_STREET_2}<\\\/p>
{BUSINESS_CITY} {BUSINESS_STATE}<\\\/p>
{BUSINESS_COUNTRY} {BUSINESS_ZIP_CODE}<\\\/p>
{BUSINESS_PHONE}<\\\/p>\",\"payment_from_customer_address_format\":\"
{BILLING_ADDRESS_STREET_1}<\\\/p>
{BILLING_ADDRESS_STREET_2}<\\\/p>
{BILLING_CITY} {BILLING_STATE}<\\\/p>
{BILLING_COUNTRY} {BILLING_ZIP_CODE}<\\\/p>
{BILLING_PHONE}<\\\/p>\",\"tax_per_item_enabled\":\"YES\",\"discount_per_item_enabled\":\"YES\"}" }, "description": "" }, "response": [] } ] }, { "name": "Customers", "description": "", "item": [ { "name": "List all customers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/customers", "query": [ { "key": "limit", "value": "3", "description": "A limit on the number of customers to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "2", "description": "Number of page (For Pagination).", "disabled": false }, { "key": "name", "value": "nemo", "description": "Filter records by name", "disabled": false }, { "key": "email", "value": "voluptate", "description": "Filter records by email", "disabled": false }, { "key": "phone", "value": "facere", "description": "Filter records by phone", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/customers?limit=3&page=2&name=nemo&email=voluptate&phone=facere" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of your customers." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1090,\"name\":\"Garrett Conroy IV\",\"business_id\":1,\"customer_business_id\":null,\"email\":\"henry.ruecker@example.com\",\"phone\":\"843.887.2253\",\"contact_first_name\":\"Madeline\",\"contact_last_name\":\"Moen\",\"website\":\"http:\\\/\\\/wuckert.com\\\/quae-fuga-eum-beatae-debitis\",\"created_at\":1667663246,\"updated_at\":1667663246,\"due_amount\":null},{\"id\":1091,\"name\":\"Foster Cronin\",\"business_id\":1,\"customer_business_id\":null,\"email\":\"jadyn.klein@example.org\",\"phone\":\"(283) 609-6644\",\"contact_first_name\":\"Geovanny\",\"contact_last_name\":\"Hermann\",\"website\":\"http:\\\/\\\/cummings.info\\\/\",\"created_at\":1667663246,\"updated_at\":1667663246,\"due_amount\":null}]}", "name": "0" } ] }, { "name": "Create a customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/customers", "query": [], "raw": "{{baseUrl}}\/api\/v2\/customers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"john\",\"email\":\"john@gmail.com\",\"phone\":\"0123123123\",\"contact_first_name\":\"xyz\",\"contact_last_name\":\"john\",\"website\":\"http:\\\/\\\/craterapp.com\",\"billing\":{\"name\":\"Crater Invoice\",\"address_street_1\":\"Address 1\",\"address_street_2\":\"Address 2\",\"city\":\"Los Angeles\",\"state\":\"California\",\"country_id\":231,\"zip\":\"91504\",\"phone\":\"0123123123\"},\"shipping\":{\"name\":\"crater Invoice\",\"address_street_1\":\"Address 1\",\"address_street_2\":\"Address 2\",\"city\":\"Los Angeles\",\"state\":\"California\",\"country_id\":231,\"zip\":\"91504\",\"phone\":\"0123123123\"}}" }, "description": "" }, "response": [] }, { "name": "Retrieve a customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "787", "description": "The ID of the customer." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves a Customer object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1092,\"name\":\"Prof. Maribel D'Amore\",\"business_id\":1,\"customer_business_id\":null,\"email\":\"rosenbaum.shanny@example.org\",\"phone\":\"+1-270-608-9144\",\"contact_first_name\":\"Jettie\",\"contact_last_name\":\"Denesik\",\"website\":\"http:\\\/\\\/www.mayert.com\\\/ut-labore-libero-fugit-rem-perferendis\",\"created_at\":1667663246,\"updated_at\":1667663246,\"due_amount\":null}}", "name": "0" } ] }, { "name": "Update a customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "787", "description": "The ID of the customer." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"john\",\"email\":\"john@gmail.com\",\"phone\":\"0123123123\",\"contact_first_name\":\"xyz\",\"contact_last_name\":\"john\",\"website\":\"http:\\\/\\\/craterapp.com\",\"billing\":{\"name\":\"Crater Invoice\",\"address_street_1\":\"Address 1\",\"address_street_2\":\"Address 2\",\"city\":\"Los Angeles\",\"state\":\"California\",\"country_id\":231,\"zip\":\"91504\",\"phone\":\"0123123123\"},\"shipping\":{\"name\":\"crater Invoice\",\"address_street_1\":\"Address 1\",\"address_street_2\":\"Address 2\",\"city\":\"Los Angeles\",\"state\":\"California\",\"country_id\":231,\"zip\":\"91504\",\"phone\":\"0123123123\"}}" }, "description": "" }, "response": [] }, { "name": "Delete customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "787", "description": "The ID of the customer." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Delete a Customer alongside all of their resources (i.e. Estimates, Invoices, Payments and Addresses)" }, "response": [] } ] }, { "name": "Estimates", "description": "", "item": [ { "name": "Send an estimate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates\/:estimate_id\/send-email", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates\/:estimate_id\/send-email", "variable": [ { "id": "estimate_id", "key": "estimate_id", "value": "1", "description": "The ID of the estimate." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"subject\":\"exercitationem\",\"body\":\"soluta\",\"reply_to\":\"minima\",\"to\":\"voluptas\"}" }, "description": "Mail a specific estimate to the corresponding customer's email address." }, "response": [] }, { "name": "Accept an incoming estimate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates\/:estimate_id\/accept", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates\/:estimate_id\/accept", "variable": [ { "id": "estimate_id", "key": "estimate_id", "value": "1", "description": "The ID of the estimate." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"status\":\"ACCEPTED\"}" }, "description": "Endpoint to accept an incoming estimate." }, "response": [] }, { "name": "Reject an incoming estimate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates\/:estimate_id\/reject", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates\/:estimate_id\/reject", "variable": [ { "id": "estimate_id", "key": "estimate_id", "value": "1", "description": "The ID of the estimate." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"status\":\"REJECTED\",\"reason\":\"alias\"}" }, "description": "Endpoint to reject an incoming estimate." }, "response": [] }, { "name": "Convert into invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates\/:estimate_id\/convert-to-invoice", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates\/:estimate_id\/convert-to-invoice", "variable": [ { "id": "estimate_id", "key": "estimate_id", "value": "1", "description": "The ID of the estimate." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add attachments to estimate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates\/:estimate_id\/attachments", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates\/:estimate_id\/attachments", "variable": [ { "id": "estimate_id", "key": "estimate_id", "value": "1", "description": "The ID of the estimate." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "This endpoint is mainly used to add an attachments to invoice." }, "response": [] }, { "name": "List all estimate templates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates\/templates", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates\/templates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "List all estimates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates", "query": [ { "key": "limit", "value": "10", "description": "A limit on the number of estimates to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "1", "description": "Number of page (For Pagination).", "disabled": false }, { "key": "status", "value": "SENT", "description": "Filter records by status.", "disabled": false }, { "key": "customer_id", "value": "1", "description": "Filter records by customer_id.", "disabled": false }, { "key": "estimate_number", "value": "", "description": "Filter records by estimate_number", "disabled": true }, { "key": "from_date", "value": "2022-11-01", "description": "Filter records by from_date.", "disabled": false }, { "key": "to_date", "value": "2022-11-04", "description": "Filter records by to_date.", "disabled": false }, { "key": "incoming", "value": "1", "description": "By default, this endpoint returns a list of outgoing estimate, but you can also fetch incoming estimates of a business using this param.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/estimates?limit=10&page=1&status=SENT&customer_id=1&estimate_number=&from_date=2022-11-01&to_date=2022-11-04&incoming=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of estimates for current business." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":92,\"estimate_date\":125884800,\"expiry_date\":437875200,\"created_at\":1667663245,\"estimate_number\":\"EST-000002\",\"sequence_number\":2,\"status\":\"DRAFT\",\"notes\":\"Eligendi magnam exercitationem rerum nisi iure.\",\"discount\":4,\"discount_type\":\"fixed\",\"discount_val\":4,\"sub_total\":3,\"total\":5,\"tax\":1,\"unique_hash\":\"ZAg6b0wEnVfhzLp9xllAWBdJRxtzgCUqDkxafVX6AMk2EzgyWzUfwST0xkUy\",\"creator_id\":null,\"template_name\":\"estimate1\",\"customer_id\":1077,\"currency_id\":1,\"estimate_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/estimates\\\/pdf\\\/ZAg6b0wEnVfhzLp9xllAWBdJRxtzgCUqDkxafVX6AMk2EzgyWzUfwST0xkUy\",\"attachments\":[],\"reject_reason\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\",\"estimate_type\":\"incoming\",\"deposit\":null,\"deductible\":null,\"deposit_processing\":null,\"deductible_processing\":null},{\"id\":93,\"estimate_date\":615254400,\"expiry_date\":1351382400,\"created_at\":1667663245,\"estimate_number\":\"EST-000003\",\"sequence_number\":3,\"status\":\"DRAFT\",\"notes\":\"Qui tenetur et ut magnam eos ex. Aut velit rem sunt cum voluptas possimus.\",\"discount\":1.28,\"discount_type\":\"percentage\",\"discount_val\":32,\"sub_total\":5,\"total\":4,\"tax\":8,\"unique_hash\":\"6rgouKRV24cfO9LRpppB83n7qrNw5pNuD8bt7TDiBF4PNPjjroK3DkYbiyZU\",\"creator_id\":null,\"template_name\":\"estimate1\",\"customer_id\":1078,\"currency_id\":1,\"estimate_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/estimates\\\/pdf\\\/6rgouKRV24cfO9LRpppB83n7qrNw5pNuD8bt7TDiBF4PNPjjroK3DkYbiyZU\",\"attachments\":[],\"reject_reason\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\",\"estimate_type\":\"incoming\",\"deposit\":null,\"deductible\":null,\"deposit_processing\":null,\"deductible_processing\":null}]}", "name": "0" } ] }, { "name": "Create an estimate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "formdata", "formdata": [ { "key": "estimate_date", "value": "2022-02-13", "type": "text", "description": "Date of the estimate." }, { "key": "expiry_date", "value": "2022-02-16", "type": "text", "description": "Due Date." }, { "key": "customer_id", "value": 1, "type": "text", "description": "Customer ID." }, { "key": "estimate_number", "value": "EST-000001", "type": "text", "description": "Estimate Number." }, { "key": "discount_type", "value": "fixed", "type": "text", "description": "Type of discount: fixed or percentage." }, { "key": "discount", "value": 50, "type": "text", "description": "Actual discount value that appears on the PDF. Pass percentage of the discount or the amount if the discount is fixed." }, { "key": "discount_val", "value": 5000, "type": "text", "description": "Total discount amount in cents." }, { "key": "tax", "value": 0, "type": "text", "description": "Total tax on the estimate in cents." }, { "key": "template_name", "value": "estimate1", "type": "text", "description": "Name of the template to be used for the Estimate PDF." }, { "key": "items[0][name]", "value": "Apple Macbook", "type": "text", "description": "" }, { "key": "items[0][quantity]", "value": 1, "type": "text", "description": "" }, { "key": "items[0][price]", "value": 10000, "type": "text", "description": "" }, { "key": "items[0][description]", "value": "Light and powerful laptop", "type": "text", "description": "" }, { "key": "items[0][item_id]", "value": 5, "type": "text", "description": "" }, { "key": "items[0][unit_name]", "value": "box", "type": "text", "description": "" }, { "key": "items[0][discount]", "value": 0, "type": "text", "description": "" }, { "key": "items[0][discount_type]", "value": "fixed", "type": "text", "description": "" }, { "key": "items[0][discount_val]", "value": 0, "type": "text", "description": "" }, { "key": "attachments[]", "src": [], "type": "file" } ] }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":94,\"estimate_date\":457833600,\"expiry_date\":1279497600,\"created_at\":1667663245,\"estimate_number\":\"EST-000002\",\"sequence_number\":2,\"status\":\"DRAFT\",\"notes\":\"Necessitatibus repellendus eligendi tempore sint recusandae eligendi.\",\"discount\":0.9,\"discount_type\":\"percentage\",\"discount_val\":15,\"sub_total\":5,\"total\":6,\"tax\":6,\"unique_hash\":\"PQ5cevUC35qNpAt4UnmASM7EDR3bMgTmnvO2dUMPsqSux5bsfVSxOQEt91Yw\",\"creator_id\":null,\"template_name\":\"estimate1\",\"customer_id\":1079,\"currency_id\":1,\"estimate_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/estimates\\\/pdf\\\/PQ5cevUC35qNpAt4UnmASM7EDR3bMgTmnvO2dUMPsqSux5bsfVSxOQEt91Yw\",\"attachments\":[],\"reject_reason\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\",\"estimate_type\":\"incoming\",\"deposit\":null,\"deductible\":null,\"deposit_processing\":null,\"deductible_processing\":null},{\"id\":95,\"estimate_date\":1324771200,\"expiry_date\":43459200,\"created_at\":1667663245,\"estimate_number\":\"EST-000003\",\"sequence_number\":3,\"status\":\"DRAFT\",\"notes\":\"Ut id asperiores qui dolorem velit possimus iure ducimus.\",\"discount\":7,\"discount_type\":\"fixed\",\"discount_val\":7,\"sub_total\":6,\"total\":5,\"tax\":9,\"unique_hash\":\"HkPpEQRWxHzf7Vi5IehjLN2Xf0707YEQ0qBzTNhmdh2bazWgerFRtXaaKbXU\",\"creator_id\":null,\"template_name\":\"estimate1\",\"customer_id\":1080,\"currency_id\":1,\"estimate_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/estimates\\\/pdf\\\/HkPpEQRWxHzf7Vi5IehjLN2Xf0707YEQ0qBzTNhmdh2bazWgerFRtXaaKbXU\",\"attachments\":[],\"reject_reason\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\",\"estimate_type\":\"incoming\",\"deposit\":null,\"deductible\":null,\"deposit_processing\":null,\"deductible_processing\":null}]}", "name": "0" } ] }, { "name": "Retrieve an estimate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the estimate." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves an Estimate object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":96,\"estimate_date\":838857600,\"expiry_date\":1497571200,\"created_at\":1667663245,\"estimate_number\":\"EST-000002\",\"sequence_number\":2,\"status\":\"DRAFT\",\"notes\":\"Voluptatem minus nisi dolores quaerat ex maiores.\",\"discount\":8,\"discount_type\":\"fixed\",\"discount_val\":8,\"sub_total\":5,\"total\":1,\"tax\":5,\"unique_hash\":\"BcLoz99PwvHjRKX4Wxyw9vVu9X2SI3j8pW5zEOBPb1dMk5GSDvcWhHkbWcmo\",\"creator_id\":null,\"template_name\":\"estimate1\",\"customer_id\":1081,\"currency_id\":1,\"estimate_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/estimates\\\/pdf\\\/BcLoz99PwvHjRKX4Wxyw9vVu9X2SI3j8pW5zEOBPb1dMk5GSDvcWhHkbWcmo\",\"attachments\":[],\"reject_reason\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\",\"estimate_type\":\"incoming\",\"deposit\":null,\"deductible\":null,\"deposit_processing\":null,\"deductible_processing\":null}}", "name": "0" } ] }, { "name": "Update an estimate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the estimate." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "formdata", "formdata": [ { "key": "estimate_date", "value": "2022-02-13", "type": "text", "description": "Date of the estimate." }, { "key": "expiry_date", "value": "2022-02-16", "type": "text", "description": "Due Date." }, { "key": "customer_id", "value": 1, "type": "text", "description": "Customer ID." }, { "key": "estimate_number", "value": "EST-000001", "type": "text", "description": "Estimate Number." }, { "key": "discount_type", "value": "fixed", "type": "text", "description": "Type of discount: fixed or percentage." }, { "key": "discount", "value": 50, "type": "text", "description": "Actual discount value that appears on the PDF. Pass percentage of the discount or the amount if the discount is fixed." }, { "key": "discount_val", "value": 5000, "type": "text", "description": "Total discount amount in cents." }, { "key": "tax", "value": 0, "type": "text", "description": "Total tax on the estimate in cents." }, { "key": "template_name", "value": "estimate1", "type": "text", "description": "Name of the template to be used for the Estimate PDF." }, { "key": "items[0][name]", "value": "Apple Macbook", "type": "text", "description": "" }, { "key": "items[0][quantity]", "value": 1, "type": "text", "description": "" }, { "key": "items[0][price]", "value": 10000, "type": "text", "description": "" }, { "key": "items[0][description]", "value": "Light and powerful laptop", "type": "text", "description": "" }, { "key": "items[0][item_id]", "value": 5, "type": "text", "description": "" }, { "key": "items[0][unit_name]", "value": "box", "type": "text", "description": "" }, { "key": "items[0][discount]", "value": 0, "type": "text", "description": "" }, { "key": "items[0][discount_type]", "value": "fixed", "type": "text", "description": "" }, { "key": "items[0][discount_val]", "value": 0, "type": "text", "description": "" }, { "key": "attachments[]", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "" }, "response": [] }, { "name": "Delete estimate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/estimates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/estimates\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the estimate." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Delete a specific Estimate" }, "response": [] } ] }, { "name": "Invoices", "description": "", "item": [ { "name": "Send an invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices\/:invoice_id\/send-email", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices\/:invoice_id\/send-email", "variable": [ { "id": "invoice_id", "key": "invoice_id", "value": "2", "description": "The ID of the invoice." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"body\":\"You have received an from xyz company.\",\"subject\":\"You have received an invoice\",\"reply_to\":\"reply@abc.com\",\"to\":\"to@abc.com\"}" }, "description": "Mail a specific invoice to the corresponding customer's email address." }, "response": [] }, { "name": "Clone an invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices\/:invoice_id\/clone", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices\/:invoice_id\/clone", "variable": [ { "id": "invoice_id", "key": "invoice_id", "value": "11", "description": "The ID of the invoice." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "" }, "response": [] }, { "name": "Approve an incoming invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices\/:invoice_id\/approve-incoming", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices\/:invoice_id\/approve-incoming", "variable": [ { "id": "invoice_id", "key": "invoice_id", "value": "12", "description": "The ID of the invoice." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Endpoint to approve an incoming invoice." }, "response": [] }, { "name": "Reject an incoming invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices\/:invoice_id\/reject-incoming", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices\/:invoice_id\/reject-incoming", "variable": [ { "id": "invoice_id", "key": "invoice_id", "value": "16", "description": "The ID of the invoice." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"The invoice does not belongs to our business.\"}" }, "description": "Endpoint to reject an incoming invoice." }, "response": [] }, { "name": "Add attachments to invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices\/:invoice_id\/attachments", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices\/:invoice_id\/attachments", "variable": [ { "id": "invoice_id", "key": "invoice_id", "value": "10", "description": "The ID of the invoice." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "This endpoint is mainly used to add an attachments to invoice." }, "response": [] }, { "name": "List all invoice templates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices\/templates", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices\/templates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "List all invoices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices", "query": [ { "key": "limit", "value": "14", "description": "A limit on the number of invoices to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "18", "description": "Number of page (For Pagination).", "disabled": false }, { "key": "status", "value": "odio", "description": "Filter records by status", "disabled": false }, { "key": "customer_id", "value": "quo", "description": "Filter records by customer_id", "disabled": false }, { "key": "invoice_number", "value": "15", "description": "Filter records by invoice_number", "disabled": false }, { "key": "from_date", "value": "quibusdam", "description": "Filter records by from_date", "disabled": false }, { "key": "to_date", "value": "vero", "description": "Filter records by to_date", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/invoices?limit=14&page=18&status=odio&customer_id=quo&invoice_number=15&from_date=quibusdam&to_date=vero" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of your invoices." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":285,\"unique_hash\":\"fCilMgsQsiZUu9lWhibDCj3z2LOhyo9ZkZNMe3Cx8M7O26BTzBaOTuKQ6K87\",\"invoicing_enabled\":true,\"invoice_date\":1169683200,\"created_at\":1667663246,\"due_date\":1054598400,\"invoice_number\":\"INV-000001\",\"status\":\"DRAFT\",\"paid_status\":\"UNPAID\",\"reject_reason\":null,\"notes\":\"Culpa voluptatem quos quas qui corrupti repudiandae.\",\"discount_type\":\"fixed\",\"discount\":3,\"discount_val\":3,\"sub_total\":7798,\"tax\":5,\"total\":7580,\"due_amount\":7580,\"sent_at\":null,\"viewed_at\":null,\"overdue_at\":null,\"template_name\":\"invoice1\",\"sequence_number\":1,\"customer_id\":1085,\"creator_id\":null,\"invoice_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/invoices\\\/pdf\\\/fCilMgsQsiZUu9lWhibDCj3z2LOhyo9ZkZNMe3Cx8M7O26BTzBaOTuKQ6K87\",\"attachments\":[],\"quickbooks_id\":null,\"ar_paid\":null,\"invoice_type\":\"incoming\",\"loan_status\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\"},{\"id\":286,\"unique_hash\":\"X4Agd3IbYJgOchZY9SaXynW5GXJL0maqRUGf5cEvvoWetuepkFA8f4OsYJO3\",\"invoicing_enabled\":true,\"invoice_date\":896400000,\"created_at\":1667663246,\"due_date\":1241136000,\"invoice_number\":\"INV-000002\",\"status\":\"DRAFT\",\"paid_status\":\"UNPAID\",\"reject_reason\":null,\"notes\":\"Incidunt autem voluptas quibusdam natus.\",\"discount_type\":\"fixed\",\"discount\":1,\"discount_val\":1,\"sub_total\":1709,\"tax\":7,\"total\":9969,\"due_amount\":9969,\"sent_at\":null,\"viewed_at\":null,\"overdue_at\":null,\"template_name\":\"invoice1\",\"sequence_number\":2,\"customer_id\":1086,\"creator_id\":null,\"invoice_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/invoices\\\/pdf\\\/X4Agd3IbYJgOchZY9SaXynW5GXJL0maqRUGf5cEvvoWetuepkFA8f4OsYJO3\",\"attachments\":[],\"quickbooks_id\":null,\"ar_paid\":null,\"invoice_type\":\"incoming\",\"loan_status\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\"}]}", "name": "0" } ] }, { "name": "Create an invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "formdata", "formdata": [ { "key": "invoice_number", "value": "INV-000001", "type": "text", "description": "Invoice Number." }, { "key": "invoice_date", "value": "2022-02-13", "type": "text", "description": "Date of the invoice." }, { "key": "due_date", "value": "2022-02-16", "type": "text", "description": "Due Date." }, { "key": "customer_id", "value": 1, "type": "text", "description": "Customer ID." }, { "key": "sub_total", "value": 10000, "type": "text", "description": "Subtotal amount of the invoice in cents." }, { "key": "discount_type", "value": "fixed", "type": "text", "description": "Type of discount: fixed or percentage." }, { "key": "discount", "value": 50, "type": "text", "description": "Actual discount value that appears on the PDF. Pass percentage of the discount or the amount if the discount is fixed." }, { "key": "discount_val", "value": 5000, "type": "text", "description": "Total discount amount in cents." }, { "key": "template_name", "value": "invoice1", "type": "text", "description": "Name of the template to be used for the Invoice PDF." }, { "key": "items[0][name]", "value": "Apple Macbook", "type": "text", "description": "" }, { "key": "items[0][quantity]", "value": 1, "type": "text", "description": "" }, { "key": "items[0][price]", "value": 10000, "type": "text", "description": "" }, { "key": "items[0][description]", "value": "Light and powerful laptop", "type": "text", "description": "" }, { "key": "items[0][item_id]", "value": 5, "type": "text", "description": "" }, { "key": "items[0][sub_total]", "value": 10000, "type": "text", "description": "" }, { "key": "items[0][total]", "value": 10000, "type": "text", "description": "" }, { "key": "items[0][unit_name]", "value": "box", "type": "text", "description": "" }, { "key": "items[0][discount]", "value": 0, "type": "text", "description": "" }, { "key": "items[0][discount_type]", "value": "fixed", "type": "text", "description": "" }, { "key": "items[0][discount_val]", "value": 0, "type": "text", "description": "" }, { "key": "total", "value": 5000, "type": "text", "description": "Total amount of the invoice in cents. Must be at least 50. Must not be greater than 99999999." }, { "key": "attachments[]", "src": [], "type": "file" } ] }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":287,\"unique_hash\":\"YjmdjEKWp6ZYpsx3Ls9dCVTshdiwAuYpL3kcotYBaKLfT5RanWDx23AYbtPB\",\"invoicing_enabled\":true,\"invoice_date\":1487635200,\"created_at\":1667663246,\"due_date\":556243200,\"invoice_number\":\"INV-000001\",\"status\":\"DRAFT\",\"paid_status\":\"UNPAID\",\"reject_reason\":null,\"notes\":\"Velit ut et accusantium autem earum rerum. Enim quidem tempore enim qui non ea.\",\"discount_type\":\"percentage\",\"discount\":3326.3,\"discount_val\":37,\"sub_total\":8653,\"tax\":6,\"total\":8990,\"due_amount\":8990,\"sent_at\":null,\"viewed_at\":null,\"overdue_at\":null,\"template_name\":\"invoice1\",\"sequence_number\":1,\"customer_id\":1087,\"creator_id\":null,\"invoice_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/invoices\\\/pdf\\\/YjmdjEKWp6ZYpsx3Ls9dCVTshdiwAuYpL3kcotYBaKLfT5RanWDx23AYbtPB\",\"attachments\":[],\"quickbooks_id\":null,\"ar_paid\":null,\"invoice_type\":\"incoming\",\"loan_status\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\"},{\"id\":288,\"unique_hash\":\"GHs58RzOph6LD6abJJxiMkUd1NEsFiNZZ8wMSEBGriilb0xwOVPTwbHxOekM\",\"invoicing_enabled\":true,\"invoice_date\":1041811200,\"created_at\":1667663246,\"due_date\":860457600,\"invoice_number\":\"INV-000002\",\"status\":\"DRAFT\",\"paid_status\":\"UNPAID\",\"reject_reason\":null,\"notes\":\"Esse et sed aspernatur repudiandae praesentium maxime.\",\"discount_type\":\"percentage\",\"discount\":3634.36,\"discount_val\":86,\"sub_total\":7491,\"tax\":3,\"total\":4226,\"due_amount\":4226,\"sent_at\":null,\"viewed_at\":null,\"overdue_at\":null,\"template_name\":\"invoice1\",\"sequence_number\":2,\"customer_id\":1088,\"creator_id\":null,\"invoice_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/invoices\\\/pdf\\\/GHs58RzOph6LD6abJJxiMkUd1NEsFiNZZ8wMSEBGriilb0xwOVPTwbHxOekM\",\"attachments\":[],\"quickbooks_id\":null,\"ar_paid\":null,\"invoice_type\":\"incoming\",\"loan_status\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\"}]}", "name": "0" } ] }, { "name": "Retrieve an invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the invoice." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves an Invoice object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":289,\"unique_hash\":\"iSpgPGl7xpCxqE8tbhQN4Yc7RoMyXNiAkoAhbwkdzed1V4SNZkfC0A1OoKNh\",\"invoicing_enabled\":true,\"invoice_date\":1019347200,\"created_at\":1667663246,\"due_date\":723859200,\"invoice_number\":\"INV-000001\",\"status\":\"DRAFT\",\"paid_status\":\"UNPAID\",\"reject_reason\":null,\"notes\":\"Voluptates omnis et atque quaerat quia dignissimos.\",\"discount_type\":\"percentage\",\"discount\":4498.34,\"discount_val\":77,\"sub_total\":3100,\"tax\":4,\"total\":5842,\"due_amount\":5842,\"sent_at\":null,\"viewed_at\":null,\"overdue_at\":null,\"template_name\":\"invoice1\",\"sequence_number\":1,\"customer_id\":1089,\"creator_id\":null,\"invoice_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/invoices\\\/pdf\\\/iSpgPGl7xpCxqE8tbhQN4Yc7RoMyXNiAkoAhbwkdzed1V4SNZkfC0A1OoKNh\",\"attachments\":[],\"quickbooks_id\":null,\"ar_paid\":null,\"invoice_type\":\"incoming\",\"loan_status\":null,\"tax_per_item_enabled\":\"NO\",\"discount_per_item_enabled\":\"NO\"}}", "name": "0" } ] }, { "name": "Update an invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the invoice." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "formdata", "formdata": [ { "key": "invoice_number", "value": "INV-000001", "type": "text", "description": "Invoice Number." }, { "key": "invoice_date", "value": "2022-02-13", "type": "text", "description": "Date of the invoice." }, { "key": "due_date", "value": "2022-02-16", "type": "text", "description": "Due Date." }, { "key": "customer_id", "value": 1, "type": "text", "description": "Customer ID." }, { "key": "sub_total", "value": 10000, "type": "text", "description": "Subtotal amount of the invoice in cents." }, { "key": "discount_type", "value": "fixed", "type": "text", "description": "Type of discount: fixed or percentage." }, { "key": "discount", "value": 50, "type": "text", "description": "Actual discount value that appears on the PDF. Pass percentage of the discount or the amount if the discount is fixed." }, { "key": "discount_val", "value": 5000, "type": "text", "description": "Total discount amount in cents." }, { "key": "template_name", "value": "invoice1", "type": "text", "description": "Name of the template to be used for the Invoice PDF." }, { "key": "items[0][name]", "value": "Apple Macbook", "type": "text", "description": "" }, { "key": "items[0][quantity]", "value": 1, "type": "text", "description": "" }, { "key": "items[0][price]", "value": 10000, "type": "text", "description": "" }, { "key": "items[0][description]", "value": "Light and powerful laptop", "type": "text", "description": "" }, { "key": "items[0][item_id]", "value": 5, "type": "text", "description": "" }, { "key": "items[0][sub_total]", "value": 10000, "type": "text", "description": "" }, { "key": "items[0][total]", "value": 10000, "type": "text", "description": "" }, { "key": "items[0][unit_name]", "value": "box", "type": "text", "description": "" }, { "key": "items[0][discount]", "value": 0, "type": "text", "description": "" }, { "key": "items[0][discount_type]", "value": "fixed", "type": "text", "description": "" }, { "key": "items[0][discount_val]", "value": 0, "type": "text", "description": "" }, { "key": "total", "value": 5000, "type": "text", "description": "Total amount of the invoice in cents. Must be at least 50. Must not be greater than 99999999." }, { "key": "attachments[]", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "" }, "response": [] }, { "name": "Delete invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the invoice." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Delete an invoice" }, "response": [] } ] }, { "name": "Payments", "description": "\nAPI Endpoints for managing payments", "item": [ { "name": "Send payment receipt", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/payments\/:payment_id\/send-email", "query": [], "raw": "{{baseUrl}}\/api\/v2\/payments\/:payment_id\/send-email", "variable": [ { "id": "payment_id", "key": "payment_id", "value": "1", "description": "The ID of the payment." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"subject\":\"You have received a payment details for your invoice\",\"body\":\"You have received a payment details for your invoice.\",\"reply_to\":\"reply@abc.com\",\"to\":\"to@abc.com\"}" }, "description": "Mail the payment receipt to the corresponding customer's email address." }, "response": [] }, { "name": "List all payments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/payments", "query": [ { "key": "limit", "value": "18", "description": "A limit on the number of payments to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "16", "description": "Number of page (For Pagination).", "disabled": false }, { "key": "payment_number", "value": "11", "description": "Filter records by payment_number", "disabled": false }, { "key": "customer_id", "value": "quisquam", "description": "Filter records by customer_id", "disabled": false }, { "key": "payment_method_id", "value": "ad", "description": "Filter records by payment_method_id", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/payments?limit=18&page=16&payment_number=11&customer_id=quisquam&payment_method_id=ad" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of your payments." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":157,\"payment_number\":\"PAY-000001\",\"payment_date\":1649721600,\"created_at\":1667663245,\"notes\":\"Ut odio explicabo modi animi consequatur ad mollitia sequi.\",\"amount\":6,\"unique_hash\":\"oYkDqp7AWafRDYc3oApZstBGDxdvBizQEDsWAeDtW9p5RbM6dmxaO8PS1YWT\",\"invoice_id\":null,\"business_id\":1,\"payment_method_id\":373,\"creator_id\":null,\"customer_id\":1082,\"currency_id\":1,\"transaction_id\":null,\"sequence_number\":1,\"payment_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/payments\\\/pdf\\\/oYkDqp7AWafRDYc3oApZstBGDxdvBizQEDsWAeDtW9p5RbM6dmxaO8PS1YWT\",\"attachments\":[],\"customer\":{\"id\":1082,\"name\":\"Tyrel Bergnaum\",\"business_id\":1,\"customer_business_id\":null,\"email\":\"lauren.luettgen@example.net\",\"phone\":\"+1-828-361-5039\",\"contact_first_name\":\"Amy\",\"contact_last_name\":\"Bahringer\",\"website\":\"https:\\\/\\\/www.rutherford.com\\\/eaque-vero-distinctio-aut-et-deleniti-aut-error\",\"created_at\":1667663245,\"updated_at\":1667663245,\"due_amount\":null,\"billing\":null,\"shipping\":null},\"payment_method\":{\"id\":373,\"name\":\"ACH\",\"business_id\":1},\"business\":{\"id\":1,\"name\":\"Jones Vendor\",\"website\":null,\"phone\":null,\"email\":\"vendor@getjones.com\",\"logo\":null,\"unique_hash\":\"l5DL6E1K8Bn8x0YVnBPO\",\"profile_completed\":0,\"slug\":\"jones-vendor\",\"contact_first_name\":null,\"contact_last_name\":null,\"charges_enabled\":null,\"payouts_enabled\":null,\"details_submitted\":null,\"business_type\":null,\"requirements\":null,\"created_at\":1667372609,\"address\":{\"id\":1,\"name\":null,\"address_street_1\":null,\"address_street_2\":null,\"city\":null,\"state\":null,\"country_id\":231,\"zip\":null,\"phone\":null,\"email\":null,\"type\":null,\"user_id\":null,\"business_id\":1,\"customer_id\":null,\"country\":{\"id\":231,\"code\":\"US\",\"name\":\"United States\",\"phone_code\":null}}},\"payment_type\":\"incoming\"},{\"id\":158,\"payment_number\":\"PAY-000002\",\"payment_date\":188784000,\"created_at\":1667663245,\"notes\":\"Possimus facilis accusamus assumenda distinctio occaecati numquam.\",\"amount\":6,\"unique_hash\":\"G58rscltWwrrPgsaozlXCubMGMpb30VzDUzcTXcRJiQczbZEvHirSoOh8iJF\",\"invoice_id\":null,\"business_id\":1,\"payment_method_id\":374,\"creator_id\":null,\"customer_id\":1083,\"currency_id\":1,\"transaction_id\":null,\"sequence_number\":2,\"payment_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/payments\\\/pdf\\\/G58rscltWwrrPgsaozlXCubMGMpb30VzDUzcTXcRJiQczbZEvHirSoOh8iJF\",\"attachments\":[],\"customer\":{\"id\":1083,\"name\":\"Stephan Hyatt\",\"business_id\":1,\"customer_business_id\":null,\"email\":\"langosh.emanuel@example.org\",\"phone\":\"828.396.9278\",\"contact_first_name\":\"Lavada\",\"contact_last_name\":\"Fritsch\",\"website\":\"http:\\\/\\\/little.org\\\/\",\"created_at\":1667663245,\"updated_at\":1667663245,\"due_amount\":null,\"billing\":null,\"shipping\":null},\"payment_method\":{\"id\":374,\"name\":\"Credit Card\",\"business_id\":1},\"business\":{\"id\":1,\"name\":\"Jones Vendor\",\"website\":null,\"phone\":null,\"email\":\"vendor@getjones.com\",\"logo\":null,\"unique_hash\":\"l5DL6E1K8Bn8x0YVnBPO\",\"profile_completed\":0,\"slug\":\"jones-vendor\",\"contact_first_name\":null,\"contact_last_name\":null,\"charges_enabled\":null,\"payouts_enabled\":null,\"details_submitted\":null,\"business_type\":null,\"requirements\":null,\"created_at\":1667372609,\"address\":{\"id\":1,\"name\":null,\"address_street_1\":null,\"address_street_2\":null,\"city\":null,\"state\":null,\"country_id\":231,\"zip\":null,\"phone\":null,\"email\":null,\"type\":null,\"user_id\":null,\"business_id\":1,\"customer_id\":null,\"country\":{\"id\":231,\"code\":\"US\",\"name\":\"United States\",\"phone_code\":null}}},\"payment_type\":\"incoming\"}]}", "name": "0" } ] }, { "name": "Retrieve a payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/payments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/payments\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the payment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves a Payment object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":159,\"payment_number\":\"PAY-000001\",\"payment_date\":1444262400,\"created_at\":1667663245,\"notes\":\"Explicabo aspernatur dicta porro animi enim veritatis occaecati.\",\"amount\":7,\"unique_hash\":\"VADHiSval0Gjtd6QrdL0u8dEkHpQYoMSM45JffDgdefEuxlB0F2UKnoISyg0\",\"invoice_id\":null,\"business_id\":1,\"payment_method_id\":375,\"creator_id\":null,\"customer_id\":1084,\"currency_id\":1,\"transaction_id\":null,\"sequence_number\":1,\"payment_pdf_url\":\"http:\\\/\\\/your-tenant.craterinvoice.com\\\/payments\\\/pdf\\\/VADHiSval0Gjtd6QrdL0u8dEkHpQYoMSM45JffDgdefEuxlB0F2UKnoISyg0\",\"attachments\":[],\"customer\":{\"id\":1084,\"name\":\"Edgar Terry\",\"business_id\":1,\"customer_business_id\":null,\"email\":\"sherman.jacobson@example.net\",\"phone\":\"+14018101941\",\"contact_first_name\":\"Neoma\",\"contact_last_name\":\"Block\",\"website\":\"http:\\\/\\\/www.huels.com\\\/et-accusamus-quaerat-tempore-deleniti-qui-officiis\",\"created_at\":1667663245,\"updated_at\":1667663245,\"due_amount\":null,\"billing\":null,\"shipping\":null},\"payment_method\":{\"id\":375,\"name\":\"ACH\",\"business_id\":1},\"business\":{\"id\":1,\"name\":\"Jones Vendor\",\"website\":null,\"phone\":null,\"email\":\"vendor@getjones.com\",\"logo\":null,\"unique_hash\":\"l5DL6E1K8Bn8x0YVnBPO\",\"profile_completed\":0,\"slug\":\"jones-vendor\",\"contact_first_name\":null,\"contact_last_name\":null,\"charges_enabled\":null,\"payouts_enabled\":null,\"details_submitted\":null,\"business_type\":null,\"requirements\":null,\"created_at\":1667372609,\"address\":{\"id\":1,\"name\":null,\"address_street_1\":null,\"address_street_2\":null,\"city\":null,\"state\":null,\"country_id\":231,\"zip\":null,\"phone\":null,\"email\":null,\"type\":null,\"user_id\":null,\"business_id\":1,\"customer_id\":null,\"country\":{\"id\":231,\"code\":\"US\",\"name\":\"United States\",\"phone_code\":null}}},\"payment_type\":\"incoming\"}}", "name": "0" } ] } ] }, { "name": "Items", "description": "\nAPI Endpoints for managing items", "item": [ { "name": "List all items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/items", "query": [ { "key": "limit", "value": "8", "description": "A limit on the number of items to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "5", "description": "Number of page (For Pagination).", "disabled": false }, { "key": "price", "value": "consequatur", "description": "Filter records by price", "disabled": false }, { "key": "unit_id", "value": "eum", "description": "Filter records by unit_id", "disabled": false }, { "key": "name", "value": "voluptates", "description": "Filter records by name", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/items?limit=8&page=5&price=consequatur&unit_id=eum&name=voluptates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of your items." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":181,\"name\":\"Prof. Marcos Kshlerin\",\"description\":\"Beatae sit consequatur adipisci. Qui illum ipsum eveniet in veritatis. Atque nobis dolorem doloremque qui commodi quis.\",\"price\":4,\"unit_id\":370,\"business_id\":1,\"creator_id\":null,\"currency_id\":null,\"created_at\":1667663246,\"updated_at\":1667663246,\"tax_per_item_enabled\":true},{\"id\":182,\"name\":\"Viviane Wehner\",\"description\":\"Qui quaerat accusamus ipsum sit quis exercitationem. Id reiciendis non et placeat. Corporis praesentium pariatur quo sint aspernatur.\",\"price\":2,\"unit_id\":371,\"business_id\":1,\"creator_id\":null,\"currency_id\":null,\"created_at\":1667663246,\"updated_at\":1667663246,\"tax_per_item_enabled\":true}]}", "name": "0" } ] }, { "name": "Create an item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/items", "query": [], "raw": "{{baseUrl}}\/api\/v2\/items" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Laptop\",\"price\":6,\"unit_id\":1}" }, "description": "" }, "response": [] }, { "name": "Retrieve an item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "The ID of the item." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves an Item object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":183,\"name\":\"Mr. Candelario Wuckert\",\"description\":\"Eius eos et facere. Et illo quia veritatis labore sequi voluptas dolorem sunt. Velit et voluptatem voluptatem. Ut quod quisquam explicabo laudantium.\",\"price\":8,\"unit_id\":372,\"business_id\":1,\"creator_id\":null,\"currency_id\":null,\"created_at\":1667663246,\"updated_at\":1667663246,\"tax_per_item_enabled\":false}}", "name": "0" } ] }, { "name": "Update an item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "20", "description": "The ID of the item." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Laptop\",\"price\":13,\"unit_id\":1}" }, "description": "" }, "response": [] }, { "name": "Delete item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the item." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Delete a specific Item" }, "response": [] } ] }, { "name": "Item Units", "description": "\nAPI Endpoints for managing item units", "item": [ { "name": "List all item units", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/item-units", "query": [ { "key": "limit", "value": "1", "description": "A limit on the number of item units to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "15", "description": "Number of page (For Pagination).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/item-units?limit=1&page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of your item units." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":373,\"name\":\"Myrna Willms\",\"business_id\":1},{\"id\":374,\"name\":\"Mr. London Sanford II\",\"business_id\":1}]}", "name": "0" } ] }, { "name": "Create an item unit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/item-units", "query": [], "raw": "{{baseUrl}}\/api\/v2\/item-units" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"box\"}" }, "description": "" }, "response": [] }, { "name": "Retrieve an item unit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/item-units\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/item-units\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item unit." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves an Item unit object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":375,\"name\":\"Miss Chloe Jast II\",\"business_id\":1}}", "name": "0" } ] }, { "name": "Update an item unit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/item-units\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/item-units\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item unit." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"box\"}" }, "description": "" }, "response": [] }, { "name": "Delete an item unit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/item-units\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/item-units\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item unit." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "General", "description": "", "item": [ { "name": "Next Sequence Number", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/next-number", "query": [], "raw": "{{baseUrl}}\/api\/v2\/next-number", "variable": [ { "id": "model", "key": "model", "value": "invoice", "description": "invoice or estimate or payment." }, { "id": "model_id", "key": "model_id", "value": "1", "description": "ID of the invoice, estimate or payment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Get Next Number for Invoices or Estimates or Payments" }, "response": [ { "header": [], "code": 200, "body": "{\n \"nextNumber\": \"INV-000001\",\n \"nextSequenceNumber\": 1\n}", "name": "" } ] } ] }, { "name": "Notes", "description": "\nAPI Endpoints for managing notes", "item": [ { "name": "List all notes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/notes", "query": [ { "key": "limit", "value": "11", "description": "A limit on the number of notes to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "4", "description": "Number of page (For Pagination).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/notes?limit=11&page=4" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of your notes." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":79,\"type\":\"Payment\",\"name\":\"ut\",\"notes\":\"Et sit sunt quis dignissimos minima. Id voluptate illo non debitis nobis ea. Ea dolore rem optio rerum placeat consequatur quidem officiis.\"},{\"id\":80,\"type\":\"Payment\",\"name\":\"minus\",\"notes\":\"Odit modi quidem aliquid velit. Est autem distinctio tenetur fugit similique quidem doloremque.\"}]}", "name": "0" } ] }, { "name": "Create a note", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/notes", "query": [], "raw": "{{baseUrl}}\/api\/v2\/notes" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"invoice note\",\"type\":\"Invoice\",\"notes\":\"Invoice should we paid within 5 days.\"}" }, "description": "" }, "response": [] }, { "name": "Retrieve a note", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/notes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/notes\/:id", "variable": [ { "id": "id", "key": "id", "value": "19", "description": "The ID of the note." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves a note object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":81,\"type\":\"Estimate\",\"name\":\"culpa\",\"notes\":\"Ab natus ratione dolorem. Quasi ratione ut sed reiciendis sed illo non. Laboriosam nesciunt voluptatum voluptates et sit.\"}}", "name": "0" } ] }, { "name": "Update a note", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/notes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/notes\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "The ID of the note." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"invoice note\",\"type\":\"Invoice\",\"notes\":\"Invoice should we paid within 5 days.\"}" }, "description": "" }, "response": [] }, { "name": "Delete a note", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/notes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/notes\/:id", "variable": [ { "id": "id", "key": "id", "value": "19", "description": "The ID of the note." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Payment Methods", "description": "\nAPI Endpoints for managing payment methods", "item": [ { "name": "List all payment methods", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/payments\/methods", "query": [ { "key": "limit", "value": "8", "description": "A limit on the number of payment methods to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "17", "description": "Number of page (For Pagination).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/payments\/methods?limit=8&page=17" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of your payment methods." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":369,\"name\":\"Credit Card\",\"business_id\":1},{\"id\":370,\"name\":\"Credit Card\",\"business_id\":1}]}", "name": "0" } ] }, { "name": "Retrieve a payment method", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/payments\/methods\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/payments\/methods\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the method." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves a Payment Method object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":371,\"name\":\"Credit Card\",\"business_id\":1},{\"id\":372,\"name\":\"ACH\",\"business_id\":1}]}", "name": "0" } ] } ] }, { "name": "Tax Types", "description": "\nAPI Endpoints for managing tax types", "item": [ { "name": "List all tax types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/tax-types", "query": [ { "key": "limit", "value": "10", "description": "A limit on the number of tax types to be returned on a single page (use value: \"all\" if there's no limit).", "disabled": false }, { "key": "page", "value": "10", "description": "Number of page (For Pagination).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/tax-types?limit=10&page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Returns a list of your tax types." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":128,\"name\":\"unde\",\"percent\":73,\"type\":null,\"description\":\"Sed ipsum aut aut doloribus et. Exercitationem laborum ex et quam. Quo et molestiae aspernatur quaerat. Quia quia magni numquam qui rerum corporis omnis.\",\"business_id\":1},{\"id\":129,\"name\":\"maxime\",\"percent\":51,\"type\":null,\"description\":\"Qui ex rerum et quibusdam et distinctio sit exercitationem. Sit quia et aperiam libero quia et et. Necessitatibus sit cum dicta quibusdam.\",\"business_id\":1}]}", "name": "0" } ] }, { "name": "Create a tax type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/tax-types", "query": [], "raw": "{{baseUrl}}\/api\/v2\/tax-types" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"tax type 1\",\"percent\":\"5\",\"description\":\"5% of the tax will be imposed on the total amount.\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":130,\"name\":\"ut\",\"percent\":87,\"type\":null,\"description\":\"Quo beatae possimus labore nulla. Odio architecto ipsam mollitia minus sequi. Laborum molestiae ut vel magni placeat consequatur veritatis.\",\"business_id\":1},{\"id\":131,\"name\":\"iste\",\"percent\":73,\"type\":null,\"description\":\"Officia dicta atque cum aperiam quia minus. In quo sint impedit omnis expedita quaerat.\",\"business_id\":1}]}", "name": "0" } ] }, { "name": "Retrieve a tax type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/tax-types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/tax-types\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tax type." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Retrieves a Tax type object" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":132,\"name\":\"est\",\"percent\":87,\"type\":null,\"description\":\"Impedit recusandae nemo qui facilis et consequuntur. Vero numquam dolor consequatur perferendis magnam quos. Officia odit fugiat sapiente quam non.\",\"business_id\":1},{\"id\":133,\"name\":\"minima\",\"percent\":94,\"type\":null,\"description\":\"Ea iusto magnam qui enim animi. Animi magni itaque sequi porro accusamus. Non nobis sit quasi inventore excepturi iusto et. A molestias fugiat est fugiat repellat aut architecto et.\",\"business_id\":1}]}", "name": "0" } ] }, { "name": "Update a tax type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/tax-types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/tax-types\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tax type." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"name\":\"tax type 1\",\"percent\":\"5\",\"description\":\"5% of the tax will be imposed on the total amount.\"}" }, "description": "" }, "response": [] }, { "name": "Delete a tax type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/tax-types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/tax-types\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tax type." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "business", "value": "1" } ], "body": null, "description": "Delete a tax type" }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": null, "type": "string" } ] } }