The Sales Invoice Reference object

Attributes

id string

Unique identifier for the object.

idx integer
pos_closing_entry_id string required
sales_invoice string required
posting_date string required
customer string required
is_return boolean

Default: false

return_against string
grand_total number required
The Sales Invoice Reference object 
{
  "id": "sales-invoice-reference_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "sales_invoice": "sales_invoice_example",
  "posting_date": "2024-01-15",
  "customer": "customer_example",
  "is_return": false,
  "return_against": "return_against_example",
  "grand_total": 0
}
GET /api/accounts/sales-invoice-reference?parent_id={id}

List sales invoice references by parent

Returns all sales invoice references belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of sales invoice reference objects belonging to the parent.

GET /api/accounts/sales-invoice-reference?parent_id={id} 
curl https://api.overplane.dev/api/accounts/sales-invoice-reference?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "sales-invoice-reference_abc123",
      "idx": 1,
      "pos_closing_entry_id": "pos_closing_entry_id_example",
      "sales_invoice": "sales_invoice_example",
      "posting_date": "2024-01-15",
      "customer": "customer_example",
      "is_return": false,
      "return_against": "return_against_example",
      "grand_total": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/sales-invoice-reference

Create a sales invoice reference

Creates a new sales invoice reference object.

Body parameters

idx integer
pos_closing_entry_id string required
sales_invoice string required
posting_date string required
customer string required
is_return boolean

Default: false

return_against string
grand_total number required

Returns

Returns the newly created sales invoice reference object if the call succeeded.

POST /api/accounts/sales-invoice-reference 
curl https://api.overplane.dev/api/accounts/sales-invoice-reference \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"pos_closing_entry_id":"pos_closing_entry_id_example","sales_invoice":"sales_invoice_example","posting_date":"2024-01-15","customer":"customer_example","grand_total":0}'
Response 
{
  "id": "sales-invoice-reference_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "sales_invoice": "sales_invoice_example",
  "posting_date": "2024-01-15",
  "customer": "customer_example",
  "is_return": false,
  "return_against": "return_against_example",
  "grand_total": 0
}
PATCH /api/accounts/sales-invoice-reference/{id}

Update a sales invoice reference

Updates the specified sales invoice reference by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the sales invoice reference to update.

Body parameters

idx integer
pos_closing_entry_id string
sales_invoice string
posting_date string
customer string
is_return boolean

Default: false

return_against string
grand_total number

Returns

Returns the updated sales invoice reference object.

PATCH /api/accounts/sales-invoice-reference/{id} 
curl https://api.overplane.dev/api/accounts/sales-invoice-reference/sales-invoice-reference_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"pos_closing_entry_id":"pos_closing_entry_id_example"}'
Response 
{
  "id": "sales-invoice-reference_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "sales_invoice": "sales_invoice_example",
  "posting_date": "2024-01-15",
  "customer": "customer_example",
  "is_return": false,
  "return_against": "return_against_example",
  "grand_total": 0
}
DELETE /api/accounts/sales-invoice-reference/{id}

Delete a sales invoice reference

Permanently deletes a sales invoice reference. This cannot be undone.

Path parameters

id string required

The identifier of the sales invoice reference to delete.

Returns

Returns a confirmation that the sales invoice reference has been deleted.

DELETE /api/accounts/sales-invoice-reference/{id} 
curl https://api.overplane.dev/api/accounts/sales-invoice-reference/sales-invoice-reference_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "sales-invoice-reference_abc123",
  "deleted": true
}
POST /api/accounts/sales-invoice-reference/reorder

Reorder sales invoice references

Updates the sort order of sales invoice references within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/accounts/sales-invoice-reference/reorder 
curl https://api.overplane.dev/api/accounts/sales-invoice-reference/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "sales-invoice-reference_abc123",
  "idx": 1,
  "pos_closing_entry_id": "pos_closing_entry_id_example",
  "sales_invoice": "sales_invoice_example",
  "posting_date": "2024-01-15",
  "customer": "customer_example",
  "is_return": false,
  "return_against": "return_against_example",
  "grand_total": 0
}