Skip to main content
POST
/
coa
/
api
/
v1
/
bill
/
{bill_id}
/
void
/
Void Bill
curl --request POST \
  --url https://api.meetcampfire.com/coa/api/v1/bill/{bill_id}/void/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "void_date": "2023-12-25"
}
'
{
  "id": 123,
  "lines": [
    {
      "id": 123,
      "account_number": "<string>",
      "account_name": "<string>",
      "department_name": "<string>",
      "bill_customer_name": "<string>",
      "tags": [
        {
          "id": 123,
          "group_name": "<string>",
          "parent_name": "<string>",
          "parent": 123,
          "is_deleted": false,
          "deleted_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "last_modified_at": "2023-11-07T05:31:56Z",
          "customer": 123,
          "group": 123
        }
      ],
      "amortization_schedule": [
        {
          "id": 123,
          "journal_entry_order": "<string>",
          "date": "2023-12-25",
          "amount": 0,
          "posted": true,
          "amortization": 123,
          "customer": 123,
          "transaction": 123,
          "bill_line": 123,
          "journal_entry": 123
        }
      ],
      "tax_rate_name": "<string>",
      "tax_rate_value": 0,
      "description": "<string>",
      "amount": 0,
      "tax": 0,
      "tax_description": "<string>",
      "source": "<string>",
      "source_id": "<string>",
      "currency": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "account": 123,
      "tax_rate": 123,
      "bill_customer": 123,
      "department": 123
    }
  ],
  "payments": [
    {
      "id": 123,
      "payment_transaction_bank_description": "<string>",
      "payment_journal_entry_order": "<string>",
      "voided_journal_entry_order": "<string>",
      "currency": "<string>",
      "amount": 0,
      "payment_date": "2023-12-25",
      "source": "<string>",
      "source_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "voided_date": "2023-12-25",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "bill": 123,
      "payment_journal_entry": 123,
      "payment_transaction": 123,
      "voided_journal_entry": 123
    }
  ],
  "payment_journal_entries": [
    123
  ],
  "status": "<string>",
  "past_due_days": 123,
  "entity_name": "<string>",
  "entity_currency": "<string>",
  "vendor_name": "<string>",
  "ap_account_name": "<string>",
  "attachments": [
    {
      "id": 123,
      "customer": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": 123,
      "created_by_name": "<string>",
      "created_by_email": "<string>",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "url": "<string>",
      "s3_content_type": "<string>",
      "s3_content_length": 1073741823,
      "s3_path": "<string>",
      "object_id": 1073741823,
      "app": "<string>",
      "model": "<string>",
      "is_deleted": false,
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_amount": 0,
  "amount_due": 123,
  "amount_paid": 0,
  "item_date": "2023-12-25",
  "voided_date": "2023-12-25",
  "voided_journal_entry_order": "<string>",
  "amortizations": "<string>",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "ramp_use_sandbox": "<string>",
  "is_deleted": false,
  "deleted_at": "2023-11-07T05:31:56Z",
  "payment_term_name": "<string>",
  "search_vector": "<string>",
  "search_text": "<string>",
  "mailing_address": "<string>",
  "terms": "custom",
  "bill_number": "<string>",
  "bill_date": "2023-12-25",
  "due_date": "2023-12-25",
  "paid_date": "2023-12-25",
  "message_on_bill": "<string>",
  "source_id": "<string>",
  "source": "<string>",
  "external_ramp_id": "<string>",
  "payment_status": "partial",
  "currency": "<string>",
  "exchange_rate": 0,
  "exchange_rate_book": 0,
  "created_at": "2023-11-07T05:31:56Z",
  "tax_behavior": "inclusive",
  "customer": 123,
  "entity": 123,
  "vendor": 123,
  "payment_term": 123,
  "journal_entry": 123,
  "source_file": 123,
  "tax_rate": 123,
  "ap_account": 123,
  "voided_journal_entry": 123
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
bill_id
integer
required

ID of the bill to void

Body

​
void_date
string<date>
required

Response

200 - application/json
​
id
integer
required
​
lines
object[]
required
​
payments
object[]
required
​
payment_journal_entries
integer[]
required
​
status
string
required
​
past_due_days
integer | null
required
​
entity_name
string
required
​
entity_currency
string
required
​
vendor_name
string
required
​
ap_account_name
string | null
required

Return AP account name with number in 'number - name' format, similar to name_and_number.

​
attachments
object[]
required
​
total_amount
number
required
Required range: -1000000000000000000 < x < 1000000000000000000
​
amount_due
number
required
​
amount_paid
number
required
Required range: -1000000000000000000 < x < 1000000000000000000
​
voided_date
string<date>
required
​
voided_journal_entry_order
string
required
​
amortizations
string
required
​
last_modified_at
string<date-time>
required
​
ramp_use_sandbox
string
required
​
is_deleted
boolean
default:false
required
​
deleted_at
string<date-time> | null
required
​
payment_term_name
string
required
​
search_vector
string | null
required
​
search_text
string | null
required
​
bill_number
string
required
Maximum length: 120
​
bill_date
string<date>
required
​
due_date
string<date>
required
​
created_at
string<date-time>
required
​
customer
integer
required
​
entity
integer
required
​
vendor
integer | null
required
​
item_date
string<date> | null
​
mailing_address
string | null
​
terms
  • custom - Custom
  • net_5 - Net 5
  • net_7 - Net 7
  • net_10 - Net 10
  • net_15 - Net 15
  • net_20 - Net 20
  • net_30 - Net 30
  • net_40 - Net 40
  • net_45 - Net 45
  • net_60 - Net 60
  • net_90 - Net 90
  • net_105 - Net 105
  • net_120 - Net 120
  • due_on_receipt - Due on Receipt
Available options:
custom,
net_5,
net_7,
net_10,
net_15,
net_20,
net_30,
net_40,
net_45,
net_60,
net_90,
net_105,
net_120,
due_on_receipt
​
paid_date
string<date> | null
​
message_on_bill
string | null
​
source_id
string | null
​
source
string | null
Maximum length: 250
​
external_ramp_id
string | null
​
payment_status
  • partial - Partially Paid
  • open - Open
  • paid - Paid
  • payment_not_found - Payment Not Found
  • payment_pending - Payment Pending
  • voided - Voided
Available options:
partial,
open,
paid,
payment_not_found,
payment_pending,
voided
​
currency
string
Maximum length: 3
​
exchange_rate
number | null
Required range: -100000000000000 < x < 100000000000000
​
exchange_rate_book
number | null
Required range: -100000000000000 < x < 100000000000000
​
tax_behavior
  • inclusive - Inclusive
  • exclusive - Exclusive
Available options:
inclusive,
exclusive
​
payment_term
integer | null

Payment term for this bill

​
journal_entry
integer | null
​
source_file
integer | null
​
tax_rate
integer | null
​
ap_account
integer | null

Accounts Payable account for this bill

​
voided_journal_entry
integer | null