Push a batch of invoice / credit-memo records from Boomi

curl --request POST \
  --url https://api.example.com/v2/integrations/providers/boomi/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "document_number": "<string>",
    "company_code": "<string>",
    "customer_code": "<string>",
    "document_date": "2023-12-25",
    "net_due_date": "2023-12-25",
    "currency": "<string>",
    "amount_in_document_currency": 123,
    "document_type": "<string>",
    "invoice_doc_type": "<string>",
    "fiscal_year": "<string>",
    "posting_date": "2023-12-25",
    "amount_in_local_currency": 123,
    "exchange_rate": "<string>",
    "reference": "<string>",
    "assignment": "<string>",
    "text": "<string>",
    "reason_code": "<string>",
    "clearing_document_number": "<string>",
    "clearing_date": "2023-12-25",
    "status_open": true,
    "line_items": [
      {
        "line_number": 123,
        "description": "<string>",
        "quantity": 123,
        "unit_amount": 123,
        "total_amount": 123
      }
    ]
  }
]
'

import requests

url = "https://api.example.com/v2/integrations/providers/boomi/invoices"

payload = [
    {
        "document_number": "<string>",
        "company_code": "<string>",
        "customer_code": "<string>",
        "document_date": "2023-12-25",
        "net_due_date": "2023-12-25",
        "currency": "<string>",
        "amount_in_document_currency": 123,
        "document_type": "<string>",
        "invoice_doc_type": "<string>",
        "fiscal_year": "<string>",
        "posting_date": "2023-12-25",
        "amount_in_local_currency": 123,
        "exchange_rate": "<string>",
        "reference": "<string>",
        "assignment": "<string>",
        "text": "<string>",
        "reason_code": "<string>",
        "clearing_document_number": "<string>",
        "clearing_date": "2023-12-25",
        "status_open": True,
        "line_items": [
            {
                "line_number": 123,
                "description": "<string>",
                "quantity": 123,
                "unit_amount": 123,
                "total_amount": 123
            }
        ]
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      document_number: '<string>',
      company_code: '<string>',
      customer_code: '<string>',
      document_date: '2023-12-25',
      net_due_date: '2023-12-25',
      currency: '<string>',
      amount_in_document_currency: 123,
      document_type: '<string>',
      invoice_doc_type: '<string>',
      fiscal_year: '<string>',
      posting_date: '2023-12-25',
      amount_in_local_currency: 123,
      exchange_rate: '<string>',
      reference: '<string>',
      assignment: '<string>',
      text: '<string>',
      reason_code: '<string>',
      clearing_document_number: '<string>',
      clearing_date: '2023-12-25',
      status_open: true,
      line_items: [
        {
          line_number: 123,
          description: '<string>',
          quantity: 123,
          unit_amount: 123,
          total_amount: 123
        }
      ]
    }
  ])
};

fetch('https://api.example.com/v2/integrations/providers/boomi/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/integrations/providers/boomi/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'document_number' => '<string>',
        'company_code' => '<string>',
        'customer_code' => '<string>',
        'document_date' => '2023-12-25',
        'net_due_date' => '2023-12-25',
        'currency' => '<string>',
        'amount_in_document_currency' => 123,
        'document_type' => '<string>',
        'invoice_doc_type' => '<string>',
        'fiscal_year' => '<string>',
        'posting_date' => '2023-12-25',
        'amount_in_local_currency' => 123,
        'exchange_rate' => '<string>',
        'reference' => '<string>',
        'assignment' => '<string>',
        'text' => '<string>',
        'reason_code' => '<string>',
        'clearing_document_number' => '<string>',
        'clearing_date' => '2023-12-25',
        'status_open' => true,
        'line_items' => [
                [
                                'line_number' => 123,
                                'description' => '<string>',
                                'quantity' => 123,
                                'unit_amount' => 123,
                                'total_amount' => 123
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/integrations/providers/boomi/invoices"

	payload := strings.NewReader("[\n  {\n    \"document_number\": \"<string>\",\n    \"company_code\": \"<string>\",\n    \"customer_code\": \"<string>\",\n    \"document_date\": \"2023-12-25\",\n    \"net_due_date\": \"2023-12-25\",\n    \"currency\": \"<string>\",\n    \"amount_in_document_currency\": 123,\n    \"document_type\": \"<string>\",\n    \"invoice_doc_type\": \"<string>\",\n    \"fiscal_year\": \"<string>\",\n    \"posting_date\": \"2023-12-25\",\n    \"amount_in_local_currency\": 123,\n    \"exchange_rate\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"assignment\": \"<string>\",\n    \"text\": \"<string>\",\n    \"reason_code\": \"<string>\",\n    \"clearing_document_number\": \"<string>\",\n    \"clearing_date\": \"2023-12-25\",\n    \"status_open\": true,\n    \"line_items\": [\n      {\n        \"line_number\": 123,\n        \"description\": \"<string>\",\n        \"quantity\": 123,\n        \"unit_amount\": 123,\n        \"total_amount\": 123\n      }\n    ]\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v2/integrations/providers/boomi/invoices")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"document_number\": \"<string>\",\n    \"company_code\": \"<string>\",\n    \"customer_code\": \"<string>\",\n    \"document_date\": \"2023-12-25\",\n    \"net_due_date\": \"2023-12-25\",\n    \"currency\": \"<string>\",\n    \"amount_in_document_currency\": 123,\n    \"document_type\": \"<string>\",\n    \"invoice_doc_type\": \"<string>\",\n    \"fiscal_year\": \"<string>\",\n    \"posting_date\": \"2023-12-25\",\n    \"amount_in_local_currency\": 123,\n    \"exchange_rate\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"assignment\": \"<string>\",\n    \"text\": \"<string>\",\n    \"reason_code\": \"<string>\",\n    \"clearing_document_number\": \"<string>\",\n    \"clearing_date\": \"2023-12-25\",\n    \"status_open\": true,\n    \"line_items\": [\n      {\n        \"line_number\": 123,\n        \"description\": \"<string>\",\n        \"quantity\": 123,\n        \"unit_amount\": 123,\n        \"total_amount\": 123\n      }\n    ]\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/integrations/providers/boomi/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"document_number\": \"<string>\",\n    \"company_code\": \"<string>\",\n    \"customer_code\": \"<string>\",\n    \"document_date\": \"2023-12-25\",\n    \"net_due_date\": \"2023-12-25\",\n    \"currency\": \"<string>\",\n    \"amount_in_document_currency\": 123,\n    \"document_type\": \"<string>\",\n    \"invoice_doc_type\": \"<string>\",\n    \"fiscal_year\": \"<string>\",\n    \"posting_date\": \"2023-12-25\",\n    \"amount_in_local_currency\": 123,\n    \"exchange_rate\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"assignment\": \"<string>\",\n    \"text\": \"<string>\",\n    \"reason_code\": \"<string>\",\n    \"clearing_document_number\": \"<string>\",\n    \"clearing_date\": \"2023-12-25\",\n    \"status_open\": true,\n    \"line_items\": [\n      {\n        \"line_number\": 123,\n        \"description\": \"<string>\",\n        \"quantity\": 123,\n        \"unit_amount\": 123,\n        \"total_amount\": 123\n      }\n    ]\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "received_at": "2023-11-07T05:31:56Z",
  "results": [
    {
      "remote_id": "<string>",
      "success": true,
      "stuut_id": "<string>",
      "error_code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "detail": "<string>"
}

POST

integrations

providers

boomi

invoices

Push a batch of invoice / credit-memo records from Boomi

curl --request POST \
  --url https://api.example.com/v2/integrations/providers/boomi/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "document_number": "<string>",
    "company_code": "<string>",
    "customer_code": "<string>",
    "document_date": "2023-12-25",
    "net_due_date": "2023-12-25",
    "currency": "<string>",
    "amount_in_document_currency": 123,
    "document_type": "<string>",
    "invoice_doc_type": "<string>",
    "fiscal_year": "<string>",
    "posting_date": "2023-12-25",
    "amount_in_local_currency": 123,
    "exchange_rate": "<string>",
    "reference": "<string>",
    "assignment": "<string>",
    "text": "<string>",
    "reason_code": "<string>",
    "clearing_document_number": "<string>",
    "clearing_date": "2023-12-25",
    "status_open": true,
    "line_items": [
      {
        "line_number": 123,
        "description": "<string>",
        "quantity": 123,
        "unit_amount": 123,
        "total_amount": 123
      }
    ]
  }
]
'

import requests

url = "https://api.example.com/v2/integrations/providers/boomi/invoices"

payload = [
    {
        "document_number": "<string>",
        "company_code": "<string>",
        "customer_code": "<string>",
        "document_date": "2023-12-25",
        "net_due_date": "2023-12-25",
        "currency": "<string>",
        "amount_in_document_currency": 123,
        "document_type": "<string>",
        "invoice_doc_type": "<string>",
        "fiscal_year": "<string>",
        "posting_date": "2023-12-25",
        "amount_in_local_currency": 123,
        "exchange_rate": "<string>",
        "reference": "<string>",
        "assignment": "<string>",
        "text": "<string>",
        "reason_code": "<string>",
        "clearing_document_number": "<string>",
        "clearing_date": "2023-12-25",
        "status_open": True,
        "line_items": [
            {
                "line_number": 123,
                "description": "<string>",
                "quantity": 123,
                "unit_amount": 123,
                "total_amount": 123
            }
        ]
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      document_number: '<string>',
      company_code: '<string>',
      customer_code: '<string>',
      document_date: '2023-12-25',
      net_due_date: '2023-12-25',
      currency: '<string>',
      amount_in_document_currency: 123,
      document_type: '<string>',
      invoice_doc_type: '<string>',
      fiscal_year: '<string>',
      posting_date: '2023-12-25',
      amount_in_local_currency: 123,
      exchange_rate: '<string>',
      reference: '<string>',
      assignment: '<string>',
      text: '<string>',
      reason_code: '<string>',
      clearing_document_number: '<string>',
      clearing_date: '2023-12-25',
      status_open: true,
      line_items: [
        {
          line_number: 123,
          description: '<string>',
          quantity: 123,
          unit_amount: 123,
          total_amount: 123
        }
      ]
    }
  ])
};

fetch('https://api.example.com/v2/integrations/providers/boomi/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/integrations/providers/boomi/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'document_number' => '<string>',
        'company_code' => '<string>',
        'customer_code' => '<string>',
        'document_date' => '2023-12-25',
        'net_due_date' => '2023-12-25',
        'currency' => '<string>',
        'amount_in_document_currency' => 123,
        'document_type' => '<string>',
        'invoice_doc_type' => '<string>',
        'fiscal_year' => '<string>',
        'posting_date' => '2023-12-25',
        'amount_in_local_currency' => 123,
        'exchange_rate' => '<string>',
        'reference' => '<string>',
        'assignment' => '<string>',
        'text' => '<string>',
        'reason_code' => '<string>',
        'clearing_document_number' => '<string>',
        'clearing_date' => '2023-12-25',
        'status_open' => true,
        'line_items' => [
                [
                                'line_number' => 123,
                                'description' => '<string>',
                                'quantity' => 123,
                                'unit_amount' => 123,
                                'total_amount' => 123
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/integrations/providers/boomi/invoices"

	payload := strings.NewReader("[\n  {\n    \"document_number\": \"<string>\",\n    \"company_code\": \"<string>\",\n    \"customer_code\": \"<string>\",\n    \"document_date\": \"2023-12-25\",\n    \"net_due_date\": \"2023-12-25\",\n    \"currency\": \"<string>\",\n    \"amount_in_document_currency\": 123,\n    \"document_type\": \"<string>\",\n    \"invoice_doc_type\": \"<string>\",\n    \"fiscal_year\": \"<string>\",\n    \"posting_date\": \"2023-12-25\",\n    \"amount_in_local_currency\": 123,\n    \"exchange_rate\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"assignment\": \"<string>\",\n    \"text\": \"<string>\",\n    \"reason_code\": \"<string>\",\n    \"clearing_document_number\": \"<string>\",\n    \"clearing_date\": \"2023-12-25\",\n    \"status_open\": true,\n    \"line_items\": [\n      {\n        \"line_number\": 123,\n        \"description\": \"<string>\",\n        \"quantity\": 123,\n        \"unit_amount\": 123,\n        \"total_amount\": 123\n      }\n    ]\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v2/integrations/providers/boomi/invoices")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"document_number\": \"<string>\",\n    \"company_code\": \"<string>\",\n    \"customer_code\": \"<string>\",\n    \"document_date\": \"2023-12-25\",\n    \"net_due_date\": \"2023-12-25\",\n    \"currency\": \"<string>\",\n    \"amount_in_document_currency\": 123,\n    \"document_type\": \"<string>\",\n    \"invoice_doc_type\": \"<string>\",\n    \"fiscal_year\": \"<string>\",\n    \"posting_date\": \"2023-12-25\",\n    \"amount_in_local_currency\": 123,\n    \"exchange_rate\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"assignment\": \"<string>\",\n    \"text\": \"<string>\",\n    \"reason_code\": \"<string>\",\n    \"clearing_document_number\": \"<string>\",\n    \"clearing_date\": \"2023-12-25\",\n    \"status_open\": true,\n    \"line_items\": [\n      {\n        \"line_number\": 123,\n        \"description\": \"<string>\",\n        \"quantity\": 123,\n        \"unit_amount\": 123,\n        \"total_amount\": 123\n      }\n    ]\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/integrations/providers/boomi/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"document_number\": \"<string>\",\n    \"company_code\": \"<string>\",\n    \"customer_code\": \"<string>\",\n    \"document_date\": \"2023-12-25\",\n    \"net_due_date\": \"2023-12-25\",\n    \"currency\": \"<string>\",\n    \"amount_in_document_currency\": 123,\n    \"document_type\": \"<string>\",\n    \"invoice_doc_type\": \"<string>\",\n    \"fiscal_year\": \"<string>\",\n    \"posting_date\": \"2023-12-25\",\n    \"amount_in_local_currency\": 123,\n    \"exchange_rate\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"assignment\": \"<string>\",\n    \"text\": \"<string>\",\n    \"reason_code\": \"<string>\",\n    \"clearing_document_number\": \"<string>\",\n    \"clearing_date\": \"2023-12-25\",\n    \"status_open\": true,\n    \"line_items\": [\n      {\n        \"line_number\": 123,\n        \"description\": \"<string>\",\n        \"quantity\": 123,\n        \"unit_amount\": 123,\n        \"total_amount\": 123\n      }\n    ]\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "received_at": "2023-11-07T05:31:56Z",
  "results": [
    {
      "remote_id": "<string>",
      "success": true,
      "stuut_id": "<string>",
      "error_code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

document_number

string

required

BKPF-BELNR or VBRK-VBELN; maps to Invoice.remote_id

company_code

string

required

BKPF-BUKRS. Tenant routing is done via the inbound Bearer key, not by this field — but Stuut stores it as a custom field for audit and downstream filtering.

customer_code

string

required

BSEG-KUNNR / VBRK-KUNRG (payer)

document_date

string<date>

required

VBRK-FKDAT or BKPF-BLDAT; maps to Invoice.issued_at

net_due_date

string<date>

required

Derived from BSEG-ZTERM + ZFBDT

currency

string

required

BKPF-WAERS; ISO 4217

amount_in_document_currency

integer

required

BSEG-WRBTR in smallest currency unit (cents)

debit_credit_indicator

enum<string>

required

BSEG-SHKZG; S=debit/invoice, H=credit memo

Available options:

S,

H

document_type

string | null

BKPF-BLART

invoice_doc_type

string | null

VBRK-FKART

fiscal_year

string | null

BKPF-GJAHR

posting_date

string<date> | null

BKPF-BUDAT

amount_in_local_currency

integer | null

BSEG-DMBTR

exchange_rate

string | null

BKPF-KURSF

reference

string | null

BKPF-XBLNR; maps to purchase_order_number

assignment

string | null

BSEG-ZUONR

text

string | null

BSEG-SGTXT; max 50 chars; maps to Invoice.memo

reason_code

string | null

BSEG-RSTGR; 3-char code

clearing_document_number

string | null

BSEG-AUGBL

clearing_date

string<date> | null

BSEG-AUGCP; sets Invoice.paid_at

status_open

boolean | null

Optional. True if the document came from BSID (open); False if from BSAD (cleared). When omitted, Stuut derives status from clearing_date — a row with a clearing date is treated as cleared (PAID), otherwise OPEN.

line_items

BoomiInvoiceLineItem · object[]

Show child attributes

Response

Successful Response

received_at

string<date-time>

required

results

BoomiInboundResult · object[]

required

Show child attributes

Push a batch of customer contact records from Boomi Attach a PDF to an existing invoice by URL — Stuut GETs the PDF from

⌘I