Sales documents endpoints

Every endpoint in Sales documents: 296 operations across 14 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.

Proposals

GET/api/sales/proposals

List proposals, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/proposals 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}

Read one proposal in full

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/comments

List the comments for a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/content

List the content for a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/content 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/dependencies

List what would break if a proposal were deleted

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/email-check

List the email check for a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/opens

List the opens for a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/opens 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/pages

List the pages for a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/pages 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/pages/{n}

List the pages for a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/pages/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/pdf

Download a proposal as a PDF

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/print

Print a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/print 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/send-draft

List the send draft for a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/send-draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/versions

List the versions of a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/versions 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/{id}/versions/{vid}

List the versions of a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/versions/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/export.csv

Download proposals as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/proposals/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/import/fields

List the fields for a proposal

curl -X GET https://app.jaicrm.ai/api/sales/proposals/import/fields 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/kanban

Read proposals arranged as a board

curl -X GET https://app.jaicrm.ai/api/sales/proposals/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposals/pivot

Summarise proposals as a pivot table

curl -X GET https://app.jaicrm.ai/api/sales/proposals/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals

Create a proposal

curl -X POST https://app.jaicrm.ai/api/sales/proposals 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/comments

Add to the comments of a proposal

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/convert

Convert a proposal into the next document

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/convert 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/duplicate

Copy a proposal

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/editing

Add to the editing of a proposal

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/editing 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/email

Send an email about a proposal

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/revise

Replace a proposal with a numbered revision

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/revise 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/save-as-template

Add to the save as template of a proposal

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/save-as-template 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/send/ai

Add to the ai of a proposal

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/send/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/share

Share a proposal

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/share 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/status

Change the status of a proposal

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/{id}/versions/{vid}/restore

Restore a proposal from the trash

curl -X POST https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/versions/RECORD_ID/restore 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/bulk/delete

Delete several proposals at once

curl -X POST https://app.jaicrm.ai/api/sales/proposals/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/bulk/pdf

Download a proposal as a PDF

curl -X POST https://app.jaicrm.ai/api/sales/proposals/bulk/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposals/import

Import proposals from a CSV file

curl -X POST https://app.jaicrm.ai/api/sales/proposals/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/proposals/{id}

Change a proposal

curl -X PATCH https://app.jaicrm.ai/api/sales/proposals/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/sales/proposals/{id}/content

Change the content of a proposal

curl -X PUT https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/content 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/proposals/{id}

Delete a proposal

curl -X DELETE https://app.jaicrm.ai/api/sales/proposals/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/proposals/{id}/comments/{commentId}

Remove from the comments of a proposal

curl -X DELETE https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/proposals/{id}/editing

Remove from the editing of a proposal

curl -X DELETE https://app.jaicrm.ai/api/sales/proposals/RECORD_ID/editing 
  -H 'Authorization: Bearer YOUR_API_KEY'

Quotations

GET/api/sales/quotations

List quotations, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/quotations 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/{id}

Read one quotation in full

curl -X GET https://app.jaicrm.ai/api/sales/quotations/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/{id}/comments

List the comments for a quotation

curl -X GET https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/{id}/dependencies

List what would break if a quotation were deleted

curl -X GET https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/{id}/email-check

List the email check for a quotation

curl -X GET https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/{id}/pdf

Download a quotation as a PDF

curl -X GET https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/{id}/print

Print a quotation

curl -X GET https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/print 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/{id}/progress

List the progress for a quotation

curl -X GET https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/progress 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/{id}/send-draft

List the send draft for a quotation

curl -X GET https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/send-draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/export.csv

Download quotations as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/quotations/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/import/fields

List the fields for a quotation

curl -X GET https://app.jaicrm.ai/api/sales/quotations/import/fields 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/kanban

Read quotations arranged as a board

curl -X GET https://app.jaicrm.ai/api/sales/quotations/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/quotations/pivot

Summarise quotations as a pivot table

curl -X GET https://app.jaicrm.ai/api/sales/quotations/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations

Create a quotation

curl -X POST https://app.jaicrm.ai/api/sales/quotations 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/comments

Add to the comments of a quotation

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/convert

Convert a quotation into the next document

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/convert 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/duplicate

Copy a quotation

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/email

Send an email about a quotation

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/invoice

Invoice a quotation directly

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/invoice 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/proforma

Add to the proforma of a quotation

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/proforma 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/progress-invoice

Add to the progress invoice of a quotation

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/progress-invoice 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/revise

Replace a quotation with a numbered revision

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/revise 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/send/ai

Add to the ai of a quotation

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/send/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/share

Share a quotation

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/share 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/{id}/status

Change the status of a quotation

curl -X POST https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/bulk/delete

Delete several quotations at once

curl -X POST https://app.jaicrm.ai/api/sales/quotations/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/bulk/pdf

Download a quotation as a PDF

curl -X POST https://app.jaicrm.ai/api/sales/quotations/bulk/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/quotations/import

Import quotations from a CSV file

curl -X POST https://app.jaicrm.ai/api/sales/quotations/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/quotations/{id}

Change a quotation

curl -X PATCH https://app.jaicrm.ai/api/sales/quotations/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/quotations/{id}

Delete a quotation

curl -X DELETE https://app.jaicrm.ai/api/sales/quotations/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/quotations/{id}/comments/{commentId}

Remove from the comments of a quotation

curl -X DELETE https://app.jaicrm.ai/api/sales/quotations/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Credit notes

GET/api/sales/credit-notes

List credit notes, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/{id}

Read one credit note in full

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/{id}/comments

List the comments for a credit note

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/{id}/credit

List the credit for a credit note

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/credit 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/{id}/dependencies

List what would break if a credit note were deleted

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/{id}/email-check

List the email check for a credit note

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/{id}/pdf

Download a credit note as a PDF

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/{id}/print

Print a credit note

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/print 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/{id}/send-draft

List the send draft for a credit note

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/send-draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/export.csv

Download credit notes as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/import/fields

List the fields for a credit note

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/import/fields 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/kanban

Read credit notes arranged as a board

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/credit-notes/pivot

Summarise credit notes as a pivot table

curl -X GET https://app.jaicrm.ai/api/sales/credit-notes/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes

Create a credit note

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/{id}/apply

Add to the apply of a credit note

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/apply 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/{id}/comments

Add to the comments of a credit note

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/{id}/duplicate

Copy a credit note

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/{id}/email

Send an email about a credit note

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/{id}/refund

Add to the refund of a credit note

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/refund 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/{id}/revise

Replace a credit note with a numbered revision

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/revise 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/{id}/send/ai

Add to the ai of a credit note

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/send/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/{id}/share

Share a credit note

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/share 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/{id}/status

Change the status of a credit note

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/bulk/delete

Delete several credit notes at once

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/bulk/pdf

Download a credit note as a PDF

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/bulk/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/credit-notes/import

Import credit notes from a CSV file

curl -X POST https://app.jaicrm.ai/api/sales/credit-notes/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/credit-notes/{id}

Change a credit note

curl -X PATCH https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/credit-notes/{id}

Delete a credit note

curl -X DELETE https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/credit-notes/{id}/apply/{applicationId}

Remove from the apply of a credit note

curl -X DELETE https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/apply/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/credit-notes/{id}/comments/{commentId}

Remove from the comments of a credit note

curl -X DELETE https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/credit-notes/{id}/refunds/{paymentId}

Remove from the refunds of a credit note

curl -X DELETE https://app.jaicrm.ai/api/sales/credit-notes/RECORD_ID/refunds/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Orders

GET/api/sales/orders

List sales orders, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/orders 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/{id}

Read one sales order in full

curl -X GET https://app.jaicrm.ai/api/sales/orders/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/{id}/comments

List the comments for a sales order

curl -X GET https://app.jaicrm.ai/api/sales/orders/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/{id}/dependencies

List what would break if a sales order were deleted

curl -X GET https://app.jaicrm.ai/api/sales/orders/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/{id}/email-check

List the email check for a sales order

curl -X GET https://app.jaicrm.ai/api/sales/orders/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/{id}/pdf

Download a sales order as a PDF

curl -X GET https://app.jaicrm.ai/api/sales/orders/RECORD_ID/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/{id}/print

Print a sales order

curl -X GET https://app.jaicrm.ai/api/sales/orders/RECORD_ID/print 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/{id}/send-draft

List the send draft for a sales order

curl -X GET https://app.jaicrm.ai/api/sales/orders/RECORD_ID/send-draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/export.csv

Download sales orders as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/orders/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/import/fields

List the fields for a sales order

curl -X GET https://app.jaicrm.ai/api/sales/orders/import/fields 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/kanban

Read sales orders arranged as a board

curl -X GET https://app.jaicrm.ai/api/sales/orders/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/orders/pivot

Summarise sales orders as a pivot table

curl -X GET https://app.jaicrm.ai/api/sales/orders/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders

Create a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/cancel-items

Add to the cancel items of a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/cancel-items 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/comments

Add to the comments of a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/convert

Convert a sales order into the next document

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/convert 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/duplicate

Copy a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/email

Send an email about a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/purchase-order

Add to the purchase order of a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/purchase-order 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/reopen-items

Add to the reopen items of a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/reopen-items 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/revise

Replace a sales order with a numbered revision

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/revise 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/send/ai

Add to the ai of a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/send/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/share

Share a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/share 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/{id}/status

Change the status of a sales order

curl -X POST https://app.jaicrm.ai/api/sales/orders/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/bulk/delete

Delete several sales orders at once

curl -X POST https://app.jaicrm.ai/api/sales/orders/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/bulk/pdf

Download a sales order as a PDF

curl -X POST https://app.jaicrm.ai/api/sales/orders/bulk/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/orders/import

Import sales orders from a CSV file

curl -X POST https://app.jaicrm.ai/api/sales/orders/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/orders/{id}

Change a sales order

curl -X PATCH https://app.jaicrm.ai/api/sales/orders/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/orders/{id}

Delete a sales order

curl -X DELETE https://app.jaicrm.ai/api/sales/orders/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/orders/{id}/comments/{commentId}

Remove from the comments of a sales order

curl -X DELETE https://app.jaicrm.ai/api/sales/orders/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Invoices

GET/api/sales/invoices

List invoices, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/invoices 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/{id}

Read one invoice in full

curl -X GET https://app.jaicrm.ai/api/sales/invoices/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/{id}/comments

List the comments for an invoice

curl -X GET https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/{id}/credit-room

How much of an invoice may still be credited

curl -X GET https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/credit-room 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/{id}/dependencies

List what would break if an invoice were deleted

curl -X GET https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/{id}/email-check

List the email check for an invoice

curl -X GET https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/{id}/pdf

Download an invoice as a PDF

curl -X GET https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/{id}/print

Print an invoice

curl -X GET https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/print 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/{id}/send-draft

List the send draft for an invoice

curl -X GET https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/send-draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/export.csv

Download invoices as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/invoices/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/import/fields

List the fields for an invoice

curl -X GET https://app.jaicrm.ai/api/sales/invoices/import/fields 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/kanban

Read invoices arranged as a board

curl -X GET https://app.jaicrm.ai/api/sales/invoices/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/invoices/pivot

Summarise invoices as a pivot table

curl -X GET https://app.jaicrm.ai/api/sales/invoices/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices

Create an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/cancel-write-off

Add to the cancel write off of an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/cancel-write-off 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/comments

Add to the comments of an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/credit-note

Raise a credit note against an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/credit-note 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/duplicate

Copy an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/email

Send an email about an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/revise

Replace an invoice with a numbered revision

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/revise 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/send/ai

Add to the ai of an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/send/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/share

Share an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/share 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/status

Change the status of an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/{id}/write-off

Add to the write off of an invoice

curl -X POST https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/write-off 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/bulk/delete

Delete several invoices at once

curl -X POST https://app.jaicrm.ai/api/sales/invoices/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/bulk/pdf

Download an invoice as a PDF

curl -X POST https://app.jaicrm.ai/api/sales/invoices/bulk/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/invoices/import

Import invoices from a CSV file

curl -X POST https://app.jaicrm.ai/api/sales/invoices/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/invoices/{id}

Change an invoice

curl -X PATCH https://app.jaicrm.ai/api/sales/invoices/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/invoices/{id}

Delete an invoice

curl -X DELETE https://app.jaicrm.ai/api/sales/invoices/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/invoices/{id}/comments/{commentId}

Remove from the comments of an invoice

curl -X DELETE https://app.jaicrm.ai/api/sales/invoices/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Proformas

GET/api/sales/proformas

List proforma invoices, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/proformas 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/{id}

Read one proforma invoice in full

curl -X GET https://app.jaicrm.ai/api/sales/proformas/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/{id}/comments

List the comments for a proforma invoice

curl -X GET https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/{id}/dependencies

List what would break if a proforma invoice were deleted

curl -X GET https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/{id}/email-check

List the email check for a proforma invoice

curl -X GET https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/{id}/pdf

Download a proforma invoice as a PDF

curl -X GET https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/{id}/print

Print a proforma invoice

curl -X GET https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/print 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/{id}/send-draft

List the send draft for a proforma invoice

curl -X GET https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/send-draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/export.csv

Download proforma invoices as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/proformas/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/import/fields

List the fields for a proforma invoice

curl -X GET https://app.jaicrm.ai/api/sales/proformas/import/fields 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/kanban

Read proforma invoices arranged as a board

curl -X GET https://app.jaicrm.ai/api/sales/proformas/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proformas/pivot

Summarise proforma invoices as a pivot table

curl -X GET https://app.jaicrm.ai/api/sales/proformas/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas

Create a proforma invoice

curl -X POST https://app.jaicrm.ai/api/sales/proformas 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/{id}/comments

Add to the comments of a proforma invoice

curl -X POST https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/{id}/convert

Convert a proforma invoice into the next document

curl -X POST https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/convert 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/{id}/duplicate

Copy a proforma invoice

curl -X POST https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/{id}/email

Send an email about a proforma invoice

curl -X POST https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/{id}/revise

Replace a proforma invoice with a numbered revision

curl -X POST https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/revise 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/{id}/send/ai

Add to the ai of a proforma invoice

curl -X POST https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/send/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/{id}/share

Share a proforma invoice

curl -X POST https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/share 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/{id}/status

Change the status of a proforma invoice

curl -X POST https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/bulk/delete

Delete several proforma invoices at once

curl -X POST https://app.jaicrm.ai/api/sales/proformas/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/bulk/pdf

Download a proforma invoice as a PDF

curl -X POST https://app.jaicrm.ai/api/sales/proformas/bulk/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proformas/import

Import proforma invoices from a CSV file

curl -X POST https://app.jaicrm.ai/api/sales/proformas/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/proformas/{id}

Change a proforma invoice

curl -X PATCH https://app.jaicrm.ai/api/sales/proformas/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/proformas/{id}

Delete a proforma invoice

curl -X DELETE https://app.jaicrm.ai/api/sales/proformas/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/proformas/{id}/comments/{commentId}

Remove from the comments of a proforma invoice

curl -X DELETE https://app.jaicrm.ai/api/sales/proformas/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Bills of supply

GET/api/sales/bills-of-supply

List bills of supply, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/{id}

Read one bill of supply in full

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/{id}/comments

List the comments for a bill of supply

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/{id}/dependencies

List what would break if a bill of supply were deleted

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/{id}/email-check

List the email check for a bill of supply

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/{id}/pdf

Download a bill of supply as a PDF

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/{id}/print

Print a bill of supply

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/print 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/{id}/send-draft

List the send draft for a bill of supply

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/send-draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/export.csv

Download bills of supply as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/import/fields

List the fields for a bill of supply

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/import/fields 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/kanban

Read bills of supply arranged as a board

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/bills-of-supply/pivot

Summarise bills of supply as a pivot table

curl -X GET https://app.jaicrm.ai/api/sales/bills-of-supply/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply

Create a bill of supply

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/{id}/comments

Add to the comments of a bill of supply

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/{id}/duplicate

Copy a bill of supply

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/{id}/email

Send an email about a bill of supply

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/{id}/revise

Replace a bill of supply with a numbered revision

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/revise 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/{id}/send/ai

Add to the ai of a bill of supply

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/send/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/{id}/share

Share a bill of supply

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/share 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/{id}/status

Change the status of a bill of supply

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/bulk/delete

Delete several bills of supply at once

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/bulk/pdf

Download a bill of supply as a PDF

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/bulk/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/bills-of-supply/import

Import bills of supply from a CSV file

curl -X POST https://app.jaicrm.ai/api/sales/bills-of-supply/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/bills-of-supply/{id}

Change a bill of supply

curl -X PATCH https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/bills-of-supply/{id}

Delete a bill of supply

curl -X DELETE https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/bills-of-supply/{id}/comments/{commentId}

Remove from the comments of a bill of supply

curl -X DELETE https://app.jaicrm.ai/api/sales/bills-of-supply/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Retainers

GET/api/sales/retainers

List retainer invoices, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/retainers 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/{id}

Read one retainer invoice in full

curl -X GET https://app.jaicrm.ai/api/sales/retainers/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/{id}/comments

List the comments for a retainer invoice

curl -X GET https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/{id}/dependencies

List what would break if a retainer invoice were deleted

curl -X GET https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/{id}/email-check

List the email check for a retainer invoice

curl -X GET https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/{id}/pdf

Download a retainer invoice as a PDF

curl -X GET https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/{id}/print

Print a retainer invoice

curl -X GET https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/print 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/{id}/send-draft

List the send draft for a retainer invoice

curl -X GET https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/send-draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/export.csv

Download retainer invoices as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/retainers/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/import/fields

List the fields for a retainer invoice

curl -X GET https://app.jaicrm.ai/api/sales/retainers/import/fields 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/kanban

Read retainer invoices arranged as a board

curl -X GET https://app.jaicrm.ai/api/sales/retainers/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/retainers/pivot

Summarise retainer invoices as a pivot table

curl -X GET https://app.jaicrm.ai/api/sales/retainers/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers

Create a retainer invoice

curl -X POST https://app.jaicrm.ai/api/sales/retainers 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/{id}/comments

Add to the comments of a retainer invoice

curl -X POST https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/{id}/duplicate

Copy a retainer invoice

curl -X POST https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/{id}/email

Send an email about a retainer invoice

curl -X POST https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/{id}/revise

Replace a retainer invoice with a numbered revision

curl -X POST https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/revise 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/{id}/send/ai

Add to the ai of a retainer invoice

curl -X POST https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/send/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/{id}/share

Share a retainer invoice

curl -X POST https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/share 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/{id}/status

Change the status of a retainer invoice

curl -X POST https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/bulk/delete

Delete several retainer invoices at once

curl -X POST https://app.jaicrm.ai/api/sales/retainers/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/bulk/pdf

Download a retainer invoice as a PDF

curl -X POST https://app.jaicrm.ai/api/sales/retainers/bulk/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/retainers/import

Import retainer invoices from a CSV file

curl -X POST https://app.jaicrm.ai/api/sales/retainers/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/retainers/{id}

Change a retainer invoice

curl -X PATCH https://app.jaicrm.ai/api/sales/retainers/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/retainers/{id}

Delete a retainer invoice

curl -X DELETE https://app.jaicrm.ai/api/sales/retainers/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/retainers/{id}/comments/{commentId}

Remove from the comments of a retainer invoice

curl -X DELETE https://app.jaicrm.ai/api/sales/retainers/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Challans

GET/api/sales/challans

List delivery challans, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/challans 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/{id}

Read one delivery challan in full

curl -X GET https://app.jaicrm.ai/api/sales/challans/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/{id}/comments

List the comments for a delivery challan

curl -X GET https://app.jaicrm.ai/api/sales/challans/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/{id}/dependencies

List what would break if a delivery challan were deleted

curl -X GET https://app.jaicrm.ai/api/sales/challans/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/{id}/email-check

List the email check for a delivery challan

curl -X GET https://app.jaicrm.ai/api/sales/challans/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/{id}/pdf

Download a delivery challan as a PDF

curl -X GET https://app.jaicrm.ai/api/sales/challans/RECORD_ID/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/{id}/print

Print a delivery challan

curl -X GET https://app.jaicrm.ai/api/sales/challans/RECORD_ID/print 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/{id}/send-draft

List the send draft for a delivery challan

curl -X GET https://app.jaicrm.ai/api/sales/challans/RECORD_ID/send-draft 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/export.csv

Download delivery challans as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/challans/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/import/fields

List the fields for a delivery challan

curl -X GET https://app.jaicrm.ai/api/sales/challans/import/fields 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/kanban

Read delivery challans arranged as a board

curl -X GET https://app.jaicrm.ai/api/sales/challans/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/challans/pivot

Summarise delivery challans as a pivot table

curl -X GET https://app.jaicrm.ai/api/sales/challans/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans

Create a delivery challan

curl -X POST https://app.jaicrm.ai/api/sales/challans 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/{id}/comments

Add to the comments of a delivery challan

curl -X POST https://app.jaicrm.ai/api/sales/challans/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/{id}/duplicate

Copy a delivery challan

curl -X POST https://app.jaicrm.ai/api/sales/challans/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/{id}/email

Send an email about a delivery challan

curl -X POST https://app.jaicrm.ai/api/sales/challans/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/{id}/revise

Replace a delivery challan with a numbered revision

curl -X POST https://app.jaicrm.ai/api/sales/challans/RECORD_ID/revise 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/{id}/send/ai

Add to the ai of a delivery challan

curl -X POST https://app.jaicrm.ai/api/sales/challans/RECORD_ID/send/ai 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/{id}/share

Share a delivery challan

curl -X POST https://app.jaicrm.ai/api/sales/challans/RECORD_ID/share 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/{id}/status

Change the status of a delivery challan

curl -X POST https://app.jaicrm.ai/api/sales/challans/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/bulk/delete

Delete several delivery challans at once

curl -X POST https://app.jaicrm.ai/api/sales/challans/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/bulk/pdf

Download a delivery challan as a PDF

curl -X POST https://app.jaicrm.ai/api/sales/challans/bulk/pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/challans/import

Import delivery challans from a CSV file

curl -X POST https://app.jaicrm.ai/api/sales/challans/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/challans/{id}

Change a delivery challan

curl -X PATCH https://app.jaicrm.ai/api/sales/challans/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/challans/{id}

Delete a delivery challan

curl -X DELETE https://app.jaicrm.ai/api/sales/challans/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/challans/{id}/comments/{commentId}

Remove from the comments of a delivery challan

curl -X DELETE https://app.jaicrm.ai/api/sales/challans/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Payments

GET/api/sales/payments

List payments received, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/sales/payments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/payments/{id}

Read one payment received in full

curl -X GET https://app.jaicrm.ai/api/sales/payments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/payments/export.csv

Download payments received as a CSV file

curl -X GET https://app.jaicrm.ai/api/sales/payments/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/payments/unapplied

List the unapplied for a payment received

curl -X GET https://app.jaicrm.ai/api/sales/payments/unapplied 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/payments

Create a payment received

curl -X POST https://app.jaicrm.ai/api/sales/payments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/payments/{id}/allocate

Add to the allocate of a payment received

curl -X POST https://app.jaicrm.ai/api/sales/payments/RECORD_ID/allocate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/payments/bulk/update

Add to the update of a payment received

curl -X POST https://app.jaicrm.ai/api/sales/payments/bulk/update 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/payments/{id}

Change a payment received

curl -X PATCH https://app.jaicrm.ai/api/sales/payments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/payments/{id}

Delete a payment received

curl -X DELETE https://app.jaicrm.ai/api/sales/payments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Proposal templates

GET/api/sales/proposal-templates

List proposal templates

curl -X GET https://app.jaicrm.ai/api/sales/proposal-templates 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposal-templates/{id}

Read one proposal template

curl -X GET https://app.jaicrm.ai/api/sales/proposal-templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/proposal-templates/preview/{hash}/{n}

Read one preview

curl -X GET https://app.jaicrm.ai/api/sales/proposal-templates/preview/RECORD_ID/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposal-templates

Create a proposal template

curl -X POST https://app.jaicrm.ai/api/sales/proposal-templates 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposal-templates/{id}/default

Create a default

curl -X POST https://app.jaicrm.ai/api/sales/proposal-templates/RECORD_ID/default 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/proposal-templates/preview

Create a preview

curl -X POST https://app.jaicrm.ai/api/sales/proposal-templates/preview 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/proposal-templates/{id}

Change a proposal template

curl -X PATCH https://app.jaicrm.ai/api/sales/proposal-templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/proposal-templates/{id}

Delete a proposal template

curl -X DELETE https://app.jaicrm.ai/api/sales/proposal-templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Recurring

GET/api/sales/recurring

List recurring

curl -X GET https://app.jaicrm.ai/api/sales/recurring 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/sales/recurring/{id}

Read one recurring

curl -X GET https://app.jaicrm.ai/api/sales/recurring/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/recurring

Create a recurring

curl -X POST https://app.jaicrm.ai/api/sales/recurring 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/recurring/{id}/{action}

Act on a recurring

curl -X POST https://app.jaicrm.ai/api/sales/recurring/RECORD_ID/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/recurring/{id}/run

Create a run

curl -X POST https://app.jaicrm.ai/api/sales/recurring/RECORD_ID/run 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/recurring/{id}

Change a recurring

curl -X PATCH https://app.jaicrm.ai/api/sales/recurring/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/recurring/{id}

Delete a recurring

curl -X DELETE https://app.jaicrm.ai/api/sales/recurring/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Signatures

GET/api/sales/signatures

List signatures

curl -X GET https://app.jaicrm.ai/api/sales/signatures 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/sales/signatures

Create a signature

curl -X POST https://app.jaicrm.ai/api/sales/signatures 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/sales/signatures/{id}

Change a signature

curl -X PATCH https://app.jaicrm.ai/api/sales/signatures/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/sales/signatures/mine

Change a mine

curl -X PUT https://app.jaicrm.ai/api/sales/signatures/mine 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/signatures/{id}

Delete a signature

curl -X DELETE https://app.jaicrm.ai/api/sales/signatures/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/sales/signatures/mine

Delete a mine

curl -X DELETE https://app.jaicrm.ai/api/sales/signatures/mine 
  -H 'Authorization: Bearer YOUR_API_KEY'

Summary

GET/api/sales/summary

Read a summary for sales documents

curl -X GET https://app.jaicrm.ai/api/sales/summary 
  -H 'Authorization: Bearer YOUR_API_KEY'