Skip to content
ZUTAX ZUTAX Documentation

Resume the transmit pipeline for an existing invoice

POST
/api/public/v1/invoices/{invoice_id}/transmit
Code sample: cURL 
curl --request POST \
  --url 'https://api.getzutax.com/api/public/v1/invoices/f3df2967-7cbe-4cca-8c8c-975ee2f6857f/transmit?async=false' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <unique-request-key>' \
  --data '{
  "submit_to_pasca": true,
  "fail_fast": true,
  "validate_party_tin_via_pasca": false
}'

Used after a composite transmit returned 422 with partial_state. Runs only the remaining steps (validate -> sign -> submit). Pass ?async=true to enqueue the work and receive a 202 with job_id.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
invoice_id
required
Invoice Id
string format: uuid

Query Parameters

Section titled “Query Parameters ”
async
Async
boolean

Request Body

Section titled “Request Body ”
Media type application/json
Any of:
TransmitOptions
object
submit_to_pasca
Submit To Pasca
boolean
default: true
fail_fast
Fail Fast
boolean
default: true
validate_party_tin_via_pasca
Validate Party Tin Via Pasca
boolean
Examples
Example Sample request

Request payload example

{
  "submit_to_pasca": true,
  "fail_fast": true,
  "validate_party_tin_via_pasca": false
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
InvoiceTransmitResult
object
invoice
required
TransmitInvoiceSummary
object
id
required
Id
string format: uuid
external_id
required
External Id
string
status
required
Status
string
Allowed values: draft submitted validated dispatched delivered accepted rejected paid cancelled
irn
Any of:
string
pasca_dispatch_id
Any of:
string
customer
required
TransmitResourceRef
object
id
required
Id
string format: uuid
external_id
required
External Id
string
created
required
Created
boolean
products
Products
Array<object>
TransmitResourceRef
object
id
required
Id
string format: uuid
external_id
required
External Id
string
created
required
Created
boolean
steps_completed
required
Steps Completed
Array<string>
Allowed values: party_upsert products_upsert invoice_create validate irn_sign pasca_submit
elapsed_ms
required
Elapsed Ms
integer
Examples
Example Sample response

200 response example

{
  "invoice": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "external_id": "string",
    "status": "draft",
    "irn": "string",
    "pasca_dispatch_id": "string"
  },
  "customer": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "external_id": "string",
    "created": true
  },
  "products": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_id": "string",
      "created": true
    }
  ],
  "steps_completed": [
    "party_upsert"
  ],
  "elapsed_ms": 1
}

202

Section titled “202 ”

Accepted

Media type application/json
JobAcceptedResponse

202 response body returned when an ERP POSTs ?async=true.

object
job_id
required
Job Id
string format: uuid
status
required
Status
string
Allowed values: queued running succeeded failed
result_url
required
Result Url
string
Examples
Example Sample response

202 response example

{
  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "queued",
  "result_url": "string"
}

422

Section titled “422 ”

Unprocessable Entity

Media type application/json
InvoiceTransmitFailure
object
error
required
TransmitErrorBody
object
type
Type
string
default: step_failed
Allowed value: step_failed
step
required
TransmitStep

Discrete steps of the composite issue+transmit pipeline.

string
Allowed values: party_upsert products_upsert invoice_create validate irn_sign pasca_submit
message
required
Message
string
code
Any of:
string
request_id
Any of:
string
details
Any of:
object
key
additional properties
any
partial_state
required
TransmitPartialState
object
external_id
required
External Id
string
invoice_id
Any of:
string format: uuid
customer_id
Any of:
string format: uuid
products
Products
Array<object>
TransmitResourceRef
object
id
required
Id
string format: uuid
external_id
required
External Id
string
created
required
Created
boolean
irn
Any of:
string
steps_completed
required
Steps Completed
Array<string>
Allowed values: party_upsert products_upsert invoice_create validate irn_sign pasca_submit
next_action
Any of:
string
Examples
Example Sample response

422 response example

{
  "error": {
    "type": "step_failed",
    "step": "party_upsert",
    "message": "string",
    "code": "string",
    "request_id": "string",
    "details": {}
  },
  "partial_state": {
    "external_id": "string",
    "invoice_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "products": [
      {}
    ],
    "irn": "string",
    "steps_completed": [
      "party_upsert"
    ]
  }
}