Void Bill

Void an existing bill.

This creates a reversing journal entry to void the bill by reversing all debit and credit amounts. The bill status will be updated to reflect the void.

POST /coa/api/v1/bill/{bill_id}/void

Void Bill

cURL

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"
}
'

200

{
  "id": 123,
  "lines": [
    {
      "id": 123,
      "account_number": "<string>",
      "account_name": "<string>",
      "department_name": "<string>",
      "department_code": "<string>",
      "bill_customer_name": "<string>",
      "tags": [
        {
          "id": 123,
          "group_name": "<string>",
          "parent_name": "<string>",
          "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,
          "parent": 123,
          "is_active": true,
          "group": 123
        }
      ],
      "amortization_schedule": [
        {
          "journal_entry_order": "<string>",
          "date": "2023-12-25",
          "amount": 0,
          "customer": 123,
          "id": 123,
          "posted": true,
          "transaction": 123,
          "bill_line": 123,
          "journal_entry": 123
        }
      ],
      "tax_rate_name": "<string>",
      "tax_rate_value": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "account": 123,
      "description": "<string>",
      "amount": 0,
      "tax": 0,
      "tax_description": "<string>",
      "tag_ids": [
        0
      ],
      "tag_group_ids": [
        0
      ],
      "source": "<string>",
      "source_id": "<string>",
      "currency": "<string>",
      "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>",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "bill": 123,
      "payment_journal_entry": 123,
      "currency": "<string>",
      "amount": 0,
      "payment_date": "2023-12-25",
      "source": "<string>",
      "source_id": "<string>",
      "voided_date": "2023-12-25",
      "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_path": "<string>",
      "app": "<string>",
      "model": "<string>",
      "is_deleted": false,
      "deleted_at": "2023-11-07T05:31:56Z",
      "s3_content_type": "<string>",
      "s3_content_length": 1073741823,
      "object_id": 1073741823
    }
  ],
  "total_amount": 0,
  "amount_due": 123,
  "amount_paid": 0,
  "voided_date": "2023-12-25",
  "voided_journal_entry_order": "<string>",
  "amortizations": "<string>",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "ramp_use_sandbox": "<string>",
  "zip_metadata": "<string>",
  "is_deleted": false,
  "deleted_at": "2023-11-07T05:31:56Z",
  "payment_term_name": "<string>",
  "search_vector": "<string>",
  "search_text": "<string>",
  "bill_number": "<string>",
  "bill_date": "2023-12-25",
  "due_date": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "customer": 123,
  "entity": 123,
  "vendor": 123,
  "item_date": "2023-12-25",
  "mailing_address": "<string>",
  "paid_date": "2023-12-25",
  "message_on_bill": "<string>",
  "ita_allocation_number": "<string>",
  "source_id": "<string>",
  "source": "<string>",
  "source_bill_data": null,
  "external_ramp_id": "<string>",
  "currency": "<string>",
  "exchange_rate": 0,
  "exchange_rate_book": 0,
  "chat_id": -1,
  "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

void_date · string<date> · required

Response

200 - application/json

id · integer · required · read-only

lines · object[] · required

Show child attributes

payments · object[] · required · read-only

Show child attributes

payment_journal_entries · integer[] · required · read-only

status · string · required · read-only

past_due_days · integer | null · required · read-only

entity_name · string · required · read-only

entity_currency · string · required · read-only

vendor_name · string · required · read-only

ap_account_name · string | null · required · read-only

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

attachments · object[] · required · read-only

Show child attributes

total_amount · number<double> · required · read-only

Required range: -1000000000000000000 < x < 1000000000000000000

amount_due · number<double> · required · read-only

amount_paid · number<double> · required · read-only

Required range: -1000000000000000000 < x < 1000000000000000000

voided_date · string<date> · required · read-only

voided_journal_entry_order · string · required · read-only

amortizations · string · required · read-only

last_modified_at · string<date-time> · required · read-only

ramp_use_sandbox · string · required · read-only

zip_metadata · string · required · read-only

is_deleted · boolean · default: false · required · read-only

deleted_at · string<date-time> | null · required · read-only

payment_term_name · string · required · read-only

search_vector · string | null · required · read-only

search_text · string | null · required · read-only

bill_number · string · required

Maximum string length: 120

bill_date · string<date> · required

due_date · string<date> · required

created_at · string<date-time> · required · read-only

customer · integer · required · read-only

entity · integer · required

vendor · integer | null · required

item_date · string<date> | null

mailing_address · string | null

terms · Option 1 · enum<string> Option 2 · enum<string> Option 3 · any

• 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

ita_allocation_number · string | null

Maximum string length: 9

Pattern: ^\d{9}$

ita_bill_type · Option 1 · enum<string> Option 2 · enum<string> Option 3 · any

Israel tax compliance: bill classification type

• other - Other
• equipment - Equipment

Available options: other, equipment

source_id · string | null

source · string | null

Maximum string length: 250

source_bill_data · unknown

external_ramp_id · string | null

payment_status · Option 1 · enum<string> Option 2 · enum<string> Option 3 · any

• 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 string length: 3

exchange_rate · number<double> | null

Required range: -100000000000000 < x < 100000000000000

exchange_rate_book · number<double> | null

Required range: -100000000000000 < x < 100000000000000

tax_behavior · Option 1 · enum<string> Option 2 · enum<string> Option 3 · any

• inclusive - Inclusive
• exclusive - Exclusive

Available options: inclusive, exclusive

bill_type · enum<string>

• BILL - Bill
• PAYROLL - Payroll
• REIMBURSEMENT - Reimbursement

Available options: BILL, PAYROLL, REIMBURSEMENT

chat_id · integer | null

Required range: -2147483648 <= x <= 2147483647

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