Skip to main content
POST
/
v1
/
invoice-audits
Create an invoice audit
curl --request POST \
  --url https://api.opereit.com/v1/invoice-audits \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'contract_id=<string>'
{
  "audit": {
    "id": "<string>",
    "contract_id": "<string>",
    "status": "PENDING",
    "created_at": "2023-11-07T05:31:56Z",
    "carrier_name": "<string>",
    "status_reason": "<string>",
    "total_line_items": 123,
    "completed_at": "2023-11-07T05:31:56Z",
    "file": {
      "id": "<string>",
      "file_url": "<string>",
      "file_name": "<string>",
      "original_file_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file_size_bytes": 123,
      "invoice_number": "<string>",
      "invoice_date": "2023-12-25",
      "account_number": "<string>",
      "billing_period_start": "2023-12-25",
      "billing_period_end": "2023-12-25",
      "currency": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.opereit.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).

Body

multipart/form-data
file
file
required

The carrier invoice document. Accepted MIME types: application/pdf, text/csv.

contract_id
string
required

ID of the contract to audit this invoice against.

Response

Audit created. Auditing runs asynchronously.

audit
object

An audit of a carrier invoice against a contract.