Create or retrieve a batch

post

https://batch.cert.ceretax.net/

This endpoint can be used to do the following:

Create a new batch record and generate a url for uploading your batch file
Retrieve information about an existing batch, such as the status or a link to the batch results.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Because this endpoint can be used to both create and retrieve batches, it supports two request and response models. Both models are documented below.

Option 1 is for creating batches

Option 2 is for retrieving batches

Request and response examples for both models are available on the right-hand side of this page.

Body Params

This object should be used when creating a new batch record.

command

string

enum

required

Set to "upload" when generating a new batch record.

Allowed:

fileName

string

required

The name of the file you will be uploading for your batch. The file name submitted in this request must match the name of the file you upload.

batchName

string

required

A custom value or name for your batch.

requestType

string

required

The request type associated with transactions in your batch. Valid options include:

telco
sale
purchase

calculationType

string

enum

required

The type of calculation.

S-sales (Default)
P-purchases

Allowed:

contentMonth

string

required

length ≤ 2

The content year and month fields determine the rules/rates CereTax uses to calculate tax. For example, if an invoice is dated 2024-04-01, set content year and month to 2024-04 so that CereTax calculates taxes using the rules and rates that are applicable to the year/month of the invoice or bill.

contentMonth must be sent using the MM format, ex. January should be sent as 01, February should be sent as 02, etc.

contentYear

string

required

length ≤ 4

contentYear must be sent using the YYYY format, ex. 2023.

profileId

string

required

The calculation Profile ID to be used for this transaction.

CereTax will provide this value. Valid values for this field for your account can also be retrieved from the List profiles endpoint.

businessType

string

enum

required

The type of telecom business for this request.

01-Retail (Default)
10-CLEC
11-IXC
12-CMRS/Wireless
13-ILEC
14-Prepaid Wireless
15-VoIP
16-TV Provider
17-Non-Regulated Reseller
18-Energy Trading
19-Traditional Regulated Utility
20-Regulated Distributor in Deregulated Market

customerType

string

enum

required

The type of customer for this invoice.

01-Residential
02-Business/Commercial (Default)
03-Industrial
04-Senior Citizen
05-Tribal Government
06-Federal Government
07-State Government
08-Local Government
10-Lifeline
11-Lifeline
12-Retail
13-Tribal Member
14-Agriculture

taxSitusRule

string

enum

Defines the address type that will be used to calculate tax on the line.

T - Ship To
V - Ship From
P - Order Placement
I - Order Approval

Allowed:

sellerType

string

enum

required

Defaults to 01

The type of seller for this invoice.

01-Nexus (Default)

Allowed:

templateName

string

The template name to use.

Response

200OK