BizKitHub
DocsAPI ReferenceBff/bff/carrier-invoice/import
postBffAdmin BFF

/bff/carrier-invoice/import

No description provided.

bffpostBffCarrier-invoiceImport

Parameters

JSON body

Request body

application/json
carrierConfigurationExternalIdstringRequired
Length: 1–∞
invoiceNumberstringRequired
Length: 1–64
issuedDatestringOptional
currencystringOptional
Length: 0–3
fileNamestringOptional
Length: 0–255
fileBase64stringRequired
Length: 1–∞
mappingobjectOptional
trackingstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null
amountstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null
weightstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null
currencystring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/carrier-invoice/import

post
curl -X POST "https://api.bizkithub.com/bff/carrier-invoice/import" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "carrierConfigurationExternalId": "example_carrierConfigurationExternalId",
  "invoiceNumber": "example_invoiceNumber",
  "issuedDate": "example_issuedDate",
  "currency": "example_currency",
  "fileName": "example_fileName",
  "fileBase64": "example_fileBase64",
  "mapping": {}
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key