ASCI API - BL (Billing)

BL (Billing) module page - how it works, an interactive test form, and the endpoint reference, all in one place. Set your tenant API Key in the Setup block below; every request sends the ApiKey header. See All Forms for the combined surface or Home for the module index.

How it works

Import billing invoice (BL) end to end.

BL (Billing)

BL is the import billing invoice: an invoice header plus a multi-row charge-lines repeater. header.invoice_no and header.customer_code are required.

Submit posts to POST /api/Bl/Submit. reference_no defaults to NEW (legacy assigns the real reference at insert); the response carries the submission_id. The customer field resolves your master data live.

Setup

API key + base URL used by every request below.

Credentials

API Key

Base URL

Leave Base URL blank to call this same server with relative paths (the normal case). Set it (e.g. https://asci-api.asciofmiami.com) to point the forms at another host. Every request below sends the ApiKey header.

Idempotency Key

Sent on every create / submit POST. Click Generate for a fresh one, or a new one is auto-generated per submit if blank.

Test form

Interactive form - POSTs to the API and shows the JSON response + HTTP status.

Maps to POST /api/Bl/Submit. Full field-by-field BL (Import Billing Invoice) form with the invoice header plus a multi-row charge lines repeater. header.invoice_no and header.customer_code are required. reference_no defaults to NEW - the real reference is auto-assigned by legacy at insert time. The customer lookup resolves your master data live.

Invoice Header

Reference Number

Metadata (JSON, optional)

Invoice Number (required)

Customer Code (required)

Customer Reference

Transaction Code

Invoice Date

Invoice Description

Shipper / Consignee

Origin / Destination

Entry Number

Entry Date

Airline / Steamship

Arrival / Departure Date

AWB / B-L Number

House AWB

GL Division

Num Pieces

Invoice Value

Weight

Remarks (one line)

Charge Lines

Check status

Submission ID

Calls GET /api/Bl/Status/{id}.

Endpoints

BL endpoint family (api/Bl). Full request schema below.

BL endpoints

Method	Path	Purpose
POST	`/api/Bl/Submit`	Submit a billing invoice. Returns `submission_id`.
POST	`/api/Bl/{submissionId}/Transmit`	Transmit a built BL.
GET	`/api/Bl`	List BL submissions.
GET	`/api/Bl/{submissionId}`	Fetch one submission.
GET	`/api/Bl/Status/{submissionId}`	Lifecycle status (used by the form's Check Status button).

Schema

Request body for POST /api/Bl/Submit. Field shape mirrors the legacy outbound JSON (IPJSONBL), so the same contract is used in both directions. Envelope: { "document": { … } }.

document (root)

Field	Type	Req?	Max	Description
`reference_no`	string	Yes	15	Reference number. Send `NEW` to auto-generate; else up to 15 alphanumeric/dash chars.
`metadata`	object	No	—	Client-supplied key/value bag (string→string, ≤50 entries), echoed on status / webhooks.
`additional_invoice_code`	string	No	1	Additional invoice code.
`header`	object	Yes	-	Invoice header (see below).
`charge_lines`	array	No	-	Charge line rows (see below).

header (object)
Field	Type	Req?	Max	Description
`invoice_no`	string	Yes	6	Invoice number.
`customer_code`	string	Yes	6	Customer code.
`customer_ref`	string	No	11	Customer reference.
`transaction_code`	string	No	1	Transaction code.
`invoice_date`	string	No	8	Julian (7) or YYYYMMDD (8).
`invoice_description`	string	No	20	Invoice description.
`shipper_consignee`	string	No	30	Shipper / consignee.
`origin_destination`	string	No	15	Origin / destination.
`entry_number`	string	No	12	Customs entry number.
`entry_date`	string	No	8	Entry date.
`airline_steamship`	string	No	17	Airline / steamship line.
`arrival_departure_date`	string	No	8	Arrival / departure date.
`awb_bl_number`	string	No	16	AWB / BL number.
`house_awb`	string	No	16	House AWB.
`gl_division`	string	No	2	GL division.
`num_pieces`	string	No	8	Number of pieces.
`invoice_value`	number	No	-	Invoice value.
`weight`	number	No	-	Weight.
`remarks`	array<string>	No	-	Free-text remark lines.

charge_lines[] (array)
Field	Type	Req?	Max	Description
`seq_no`	string	No	3	Line sequence number.
`company_code`	string	No	1	Company code.
`vendor_code`	string	No	6	Vendor code.
`transaction_code`	string	No	1	Transaction code.
`log_type_code`	string	No	1	Log type code.
`charge_code`	string	No	3	Charge code.
`gl_number`	string	No	12	GL number.
`ap_gl_number`	string	No	12	AP GL number.
`prepaid_indicator`	string	No	1	Prepaid indicator.
`charge_description`	string	No	28	Charge description.
`awb_bl_number`	string	No	11	AWB / BL number.
`pending_charge_ind`	string	No	1	Pending-charge indicator.
`charge_amount`	number	No	-	Charge (AR) amount.
`ap_amount`	number	No	-	AP amount.