Create CustomerCreditV2 record

curl --request POST \
  --url https://api.dualentry.com/public/v3-alpha/customer-credits/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "company_id": 123,
  "exchange_rate": 123,
  "bill_to_address": "",
  "ship_to_address": "",
  "billing_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "supply_date": "2023-12-25",
  "place_of_supply": "<string>",
  "tax_registration_numbers": {
    "company": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ],
    "counterparty": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ]
  },
  "tax_metadata": {},
  "custom_fields": [
    {}
  ],
  "transaction_date": "2023-12-25",
  "auto_calculate_tax": "required",
  "invoice_number": 123,
  "cash_sale_number": 123,
  "customer_id": 123,
  "memo": "",
  "reference_number": "",
  "items": [],
  "attachments": [],
  "record_status": "posted",
  "contract_id": 123
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/customer-credits/"

payload = {
    "date": "2023-12-25",
    "company_id": 123,
    "exchange_rate": 123,
    "bill_to_address": "",
    "ship_to_address": "",
    "billing_address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "shipping_address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "supply_date": "2023-12-25",
    "place_of_supply": "<string>",
    "tax_registration_numbers": {
        "company": [
            {
                "type": "<string>",
                "number": "<string>",
                "region": "<string>"
            }
        ],
        "counterparty": [
            {
                "type": "<string>",
                "number": "<string>",
                "region": "<string>"
            }
        ]
    },
    "tax_metadata": {},
    "custom_fields": [{}],
    "transaction_date": "2023-12-25",
    "auto_calculate_tax": "required",
    "invoice_number": 123,
    "cash_sale_number": 123,
    "customer_id": 123,
    "memo": "",
    "reference_number": "",
    "items": [],
    "attachments": [],
    "record_status": "posted",
    "contract_id": 123
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date: '2023-12-25',
    company_id: 123,
    exchange_rate: 123,
    bill_to_address: '',
    ship_to_address: '',
    billing_address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    shipping_address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    supply_date: '2023-12-25',
    place_of_supply: '<string>',
    tax_registration_numbers: {
      company: [{type: '<string>', number: '<string>', region: '<string>'}],
      counterparty: [{type: '<string>', number: '<string>', region: '<string>'}]
    },
    tax_metadata: {},
    custom_fields: [{}],
    transaction_date: '2023-12-25',
    auto_calculate_tax: 'required',
    invoice_number: 123,
    cash_sale_number: 123,
    customer_id: 123,
    memo: '',
    reference_number: '',
    items: [],
    attachments: [],
    record_status: 'posted',
    contract_id: 123
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/customer-credits/', 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.dualentry.com/public/v3-alpha/customer-credits/",
  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([
    'date' => '2023-12-25',
    'company_id' => 123,
    'exchange_rate' => 123,
    'bill_to_address' => '',
    'ship_to_address' => '',
    'billing_address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'shipping_address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'supply_date' => '2023-12-25',
    'place_of_supply' => '<string>',
    'tax_registration_numbers' => [
        'company' => [
                [
                                'type' => '<string>',
                                'number' => '<string>',
                                'region' => '<string>'
                ]
        ],
        'counterparty' => [
                [
                                'type' => '<string>',
                                'number' => '<string>',
                                'region' => '<string>'
                ]
        ]
    ],
    'tax_metadata' => [
        
    ],
    'custom_fields' => [
        [
                
        ]
    ],
    'transaction_date' => '2023-12-25',
    'auto_calculate_tax' => 'required',
    'invoice_number' => 123,
    'cash_sale_number' => 123,
    'customer_id' => 123,
    'memo' => '',
    'reference_number' => '',
    'items' => [
        
    ],
    'attachments' => [
        
    ],
    'record_status' => 'posted',
    'contract_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.dualentry.com/public/v3-alpha/customer-credits/"

	payload := strings.NewReader("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"exchange_rate\": 123,\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"auto_calculate_tax\": \"required\",\n  \"invoice_number\": 123,\n  \"cash_sale_number\": 123,\n  \"customer_id\": 123,\n  \"memo\": \"\",\n  \"reference_number\": \"\",\n  \"items\": [],\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"contract_id\": 123\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.dualentry.com/public/v3-alpha/customer-credits/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"exchange_rate\": 123,\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"auto_calculate_tax\": \"required\",\n  \"invoice_number\": 123,\n  \"cash_sale_number\": 123,\n  \"customer_id\": 123,\n  \"memo\": \"\",\n  \"reference_number\": \"\",\n  \"items\": [],\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"contract_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/customer-credits/")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"exchange_rate\": 123,\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"auto_calculate_tax\": \"required\",\n  \"invoice_number\": 123,\n  \"cash_sale_number\": 123,\n  \"customer_id\": 123,\n  \"memo\": \"\",\n  \"reference_number\": \"\",\n  \"items\": [],\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"contract_id\": 123\n}"

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

{
  "bill_to_address": "<string>",
  "ship_to_address": "<string>",
  "transaction_ids": [
    123
  ],
  "internal_id": 123,
  "number": 123,
  "invoice_number": 123,
  "cash_sale_number": 123,
  "date": "2023-12-25",
  "transaction_date": "2023-12-25",
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "currency_iso_4217_code": "AED",
  "exchange_rate": "<string>",
  "amount": "<string>",
  "used_amount": "<string>",
  "remaining_amount": "<string>",
  "memo": "<string>",
  "reference_number": "<string>",
  "record_status": "draft",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "billing_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "customer_id": 123,
  "customer_name": "<string>",
  "attachments": [],
  "custom_fields": [],
  "integration_remote_records": [],
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "items": [],
  "contract_id": 123,
  "contracted": false,
  "e_invoice": {
    "filing_id": 123,
    "status": "queued",
    "country": "AA",
    "send_held": true,
    "needs_attention": true,
    "authority_reference": "<string>",
    "lifecycle": "authority_clearance",
    "send_held_reason": "awaiting_clearance",
    "blocked_reason": "workspace_missing"
  },
  "has_more_lines": false,
  "lines_count": 0
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

Customer Credits

Create CustomerCreditV2 record

Create a new CustomerCreditV2 record with the provided data. Validates all required fields and business rules.

Side effects

If an approval workflow matches this request, DualEntry can set record_status back to draft.
If this request posts a credit for an invoice that DualEntry filed, DualEntry checks the credit note with the authority and queues the filing.

Additional validations

Fails with 422 if the credit names an invoice whose e-invoice the authority has not cleared. The e_invoicing key holds the reason. Post the credit after the authority clears the invoice.
Fails with 422 if the e-invoice of the posted record has data that the authority refuses. The e_invoicing key lists the reasons.
Fails with 422 and the error code posting_date_after_limit if date is after the latest posting date that your organization allows.
Fails with 422 if you set an inactive, archived, or draft customer or vendor, or an inactive company.
Fails with 422 if you set the customer or vendor that stands for the record’s own company as a party.
A reference that the record or its linked source record already holds passes these checks.

POST

public

v3-alpha

customer-credits

Create CustomerCreditV2 record

curl --request POST \
  --url https://api.dualentry.com/public/v3-alpha/customer-credits/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "company_id": 123,
  "exchange_rate": 123,
  "bill_to_address": "",
  "ship_to_address": "",
  "billing_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "supply_date": "2023-12-25",
  "place_of_supply": "<string>",
  "tax_registration_numbers": {
    "company": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ],
    "counterparty": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ]
  },
  "tax_metadata": {},
  "custom_fields": [
    {}
  ],
  "transaction_date": "2023-12-25",
  "auto_calculate_tax": "required",
  "invoice_number": 123,
  "cash_sale_number": 123,
  "customer_id": 123,
  "memo": "",
  "reference_number": "",
  "items": [],
  "attachments": [],
  "record_status": "posted",
  "contract_id": 123
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/customer-credits/"

payload = {
    "date": "2023-12-25",
    "company_id": 123,
    "exchange_rate": 123,
    "bill_to_address": "",
    "ship_to_address": "",
    "billing_address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "shipping_address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "supply_date": "2023-12-25",
    "place_of_supply": "<string>",
    "tax_registration_numbers": {
        "company": [
            {
                "type": "<string>",
                "number": "<string>",
                "region": "<string>"
            }
        ],
        "counterparty": [
            {
                "type": "<string>",
                "number": "<string>",
                "region": "<string>"
            }
        ]
    },
    "tax_metadata": {},
    "custom_fields": [{}],
    "transaction_date": "2023-12-25",
    "auto_calculate_tax": "required",
    "invoice_number": 123,
    "cash_sale_number": 123,
    "customer_id": 123,
    "memo": "",
    "reference_number": "",
    "items": [],
    "attachments": [],
    "record_status": "posted",
    "contract_id": 123
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date: '2023-12-25',
    company_id: 123,
    exchange_rate: 123,
    bill_to_address: '',
    ship_to_address: '',
    billing_address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    shipping_address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    supply_date: '2023-12-25',
    place_of_supply: '<string>',
    tax_registration_numbers: {
      company: [{type: '<string>', number: '<string>', region: '<string>'}],
      counterparty: [{type: '<string>', number: '<string>', region: '<string>'}]
    },
    tax_metadata: {},
    custom_fields: [{}],
    transaction_date: '2023-12-25',
    auto_calculate_tax: 'required',
    invoice_number: 123,
    cash_sale_number: 123,
    customer_id: 123,
    memo: '',
    reference_number: '',
    items: [],
    attachments: [],
    record_status: 'posted',
    contract_id: 123
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/customer-credits/', 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.dualentry.com/public/v3-alpha/customer-credits/",
  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([
    'date' => '2023-12-25',
    'company_id' => 123,
    'exchange_rate' => 123,
    'bill_to_address' => '',
    'ship_to_address' => '',
    'billing_address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'shipping_address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'supply_date' => '2023-12-25',
    'place_of_supply' => '<string>',
    'tax_registration_numbers' => [
        'company' => [
                [
                                'type' => '<string>',
                                'number' => '<string>',
                                'region' => '<string>'
                ]
        ],
        'counterparty' => [
                [
                                'type' => '<string>',
                                'number' => '<string>',
                                'region' => '<string>'
                ]
        ]
    ],
    'tax_metadata' => [
        
    ],
    'custom_fields' => [
        [
                
        ]
    ],
    'transaction_date' => '2023-12-25',
    'auto_calculate_tax' => 'required',
    'invoice_number' => 123,
    'cash_sale_number' => 123,
    'customer_id' => 123,
    'memo' => '',
    'reference_number' => '',
    'items' => [
        
    ],
    'attachments' => [
        
    ],
    'record_status' => 'posted',
    'contract_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.dualentry.com/public/v3-alpha/customer-credits/"

	payload := strings.NewReader("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"exchange_rate\": 123,\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"auto_calculate_tax\": \"required\",\n  \"invoice_number\": 123,\n  \"cash_sale_number\": 123,\n  \"customer_id\": 123,\n  \"memo\": \"\",\n  \"reference_number\": \"\",\n  \"items\": [],\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"contract_id\": 123\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.dualentry.com/public/v3-alpha/customer-credits/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"exchange_rate\": 123,\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"auto_calculate_tax\": \"required\",\n  \"invoice_number\": 123,\n  \"cash_sale_number\": 123,\n  \"customer_id\": 123,\n  \"memo\": \"\",\n  \"reference_number\": \"\",\n  \"items\": [],\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"contract_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/customer-credits/")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"exchange_rate\": 123,\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"auto_calculate_tax\": \"required\",\n  \"invoice_number\": 123,\n  \"cash_sale_number\": 123,\n  \"customer_id\": 123,\n  \"memo\": \"\",\n  \"reference_number\": \"\",\n  \"items\": [],\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"contract_id\": 123\n}"

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

{
  "bill_to_address": "<string>",
  "ship_to_address": "<string>",
  "transaction_ids": [
    123
  ],
  "internal_id": 123,
  "number": 123,
  "invoice_number": 123,
  "cash_sale_number": 123,
  "date": "2023-12-25",
  "transaction_date": "2023-12-25",
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "currency_iso_4217_code": "AED",
  "exchange_rate": "<string>",
  "amount": "<string>",
  "used_amount": "<string>",
  "remaining_amount": "<string>",
  "memo": "<string>",
  "reference_number": "<string>",
  "record_status": "draft",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "billing_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "customer_id": 123,
  "customer_name": "<string>",
  "attachments": [],
  "custom_fields": [],
  "integration_remote_records": [],
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "items": [],
  "contract_id": 123,
  "contracted": false,
  "e_invoice": {
    "filing_id": 123,
    "status": "queued",
    "country": "AA",
    "send_held": true,
    "needs_attention": true,
    "authority_reference": "<string>",
    "lifecycle": "authority_clearance",
    "send_held_reason": "awaiting_clearance",
    "blocked_reason": "workspace_missing"
  },
  "has_more_lines": false,
  "lines_count": 0
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Headers

Idempotency-Key

string

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Maximum string length: 255

Query Parameters

apply_default_classifications

boolean

default:true

When false, store submitted line classifications, including an empty list. When omitted, organization defaults apply to new lines with omitted or empty classifications only when the organization setting is enabled.

Body

application/json

Input schema for creating Customer Credit records.

date

string<date>

required

company_id

integer

required

currency_iso_4217_code

enum<string>

required

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XAG,

XAU,

XCD,

XDR,

XOF,

XPD,

XPF,

XPT,

YER,

ZAR,

ZMW,

ZWL

exchange_rate

required

bill_to_address

string | null

default:""

deprecated

Deprecated: send the structured billing_address / shipping_address instead.

ship_to_address

string | null

default:""

deprecated

Deprecated: send the structured billing_address / shipping_address instead.

billing_address

AddressSchemaIn · object | null

Show child attributes

shipping_address

AddressSchemaIn · object | null

Show child attributes

supply_date

string<date> | null

Tax point date for VAT and GST.

When the saved record uses a VAT or GST tax regime and you omit this field, DualEntry sets it to transaction_date, or to date when there is no transaction_date.

Recurring templates store the value you send. Each generated record that uses VAT or GST and has no supply date gets that default on save.

On PATCH, an omitted field keeps the stored value. Send supply_date again when you change date or transaction_date.

place_of_supply

string | null

Maximum string length: 2

tax_registration_numbers

TaxRegistrationNumbersSnapshot · object | null

Show child attributes

tax_metadata

object | null

Show child attributes

custom_fields

Custom Fields · object[] | null

transaction_date

string<date> | null

auto_calculate_tax

enum<string> | null

Configures how to handle automatic tax calculations.

If auto_calculate_tax is unset, the tax you send on each line is stored. Set it to required to have DualEntry calculate the tax, replacing the tax on every line before it saves the record.

The calculation covers native US sales tax using DualEntry's tax engine. It also covers Avalara US sales tax, VAT, and GST.

For native VAT and GST, leave this field unset and send the rate and the tax on each line. Set it to required when a tax provider returns the tax.
The request fails with 422 when the result is DualEntry's own VAT or GST, when the calculation cannot finish, or when a required address is still missing.
When the record has a customer, DualEntry reads shipping_address, then billing_address, then the address saved on the customer.
If you send neither address, DualEntry copies the customer's saved address to billing_address and shipping_address.
When the record has a vendor, DualEntry reads ship_from_address and ship_to_address, then the addresses saved on the vendor and the company.
DualEntry stores only the ship addresses you sent.

Available options:

required

invoice_number

integer | null

cash_sale_number

integer | null

customer_id

integer | null

If this customer is intercompany, DualEntry also writes a transaction in the elimination company.

memo

string

default:""

reference_number

string

default:""

items

PublicCustomerCreditItemIn · object[]

Show child attributes

attachments

AttachmentSchemaOut · object[]

Show child attributes

record_status

enum<string>

default:posted

Available options:

draft,

posted,

archived

contract_id

integer | null

Response

bill_to_address

string

required

deprecated

Deprecated: send the structured billing_address / shipping_address instead.

ship_to_address

string

required

deprecated

Deprecated: send the structured billing_address / shipping_address instead.

transaction_ids

integer[]

required

internal_id

integer

required

number

integer

required

invoice_number

integer | null

required

cash_sale_number

integer | null

required

date

string<date>

required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_date

string<date>

required

Transaction date (inception date) - the date when the transaction actually occurred

company_id

integer

required

company_name

string

required

company_currency

string

required

currency_iso_4217_code

enum<string> | null

required

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XAG,

XAU,

XCD,

XDR,

XOF,

XPD,

XPF,

XPT,

YER,

ZAR,

ZMW,

ZWL

exchange_rate

string

required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,16}0*$

amount

string

required

Total transaction amount

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$

used_amount

string

required

Amount that was already applied to Invoices through Customer Refunds or Customer Prepayment Applications

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$

remaining_amount

string

required

Amount that can be applied to Invoices through Customer Refunds or Customer Prepayment Applications

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$

memo

string

required

reference_number

string

required

record_status

enum<string>

required

Available options:

draft,

posted,

archived

created_at

string<date-time>

required

Date and time the record was created

updated_at

string<date-time>

required

Date and time the record was last updated

billing_address

AddressSchemaOut · object | null

Show child attributes

shipping_address

AddressSchemaOut · object | null

Show child attributes

customer_id

integer | null

customer_name

string | null

attachments

PublicAttachmentSchemaOut · object[]

Show child attributes

custom_fields

CustomFieldValuePairOutputSchema · object[]

Show child attributes

integration_remote_records

IntegrationRemoteRecordSchemaOut · object[]

Show child attributes

created_by

AuditActorSchemaOut · object | null

Schema for audit actor information.

Show child attributes

updated_by

AuditActorSchemaOut · object | null

Schema for audit actor information.

Show child attributes

code

string | null

items

PublicCustomerCreditItemOut · object[]

Show child attributes

contract_id

integer | null

contracted

boolean

default:false

e_invoice

PublicEInvoiceSummarySchemaOut · object | null

The e-invoice filing of the record. Null when DualEntry did not file it. Not in v1.

Show child attributes

has_more_lines

boolean

default:false

lines_count

integer

default:0

Overview

Organization

Accounting Setup

Transactions

Money In

Money Out

Financial & Banking

Assets

Tax

Financial Planning

Reporting

Governance

Developers

Monitoring

OAuth

Create CustomerCreditV2 record

Authorizations

Headers

Query Parameters

Body

Response