Skip to main content
Aria Knowledge Central

get_einvoice_statement_m

Summary

API Name get_einvoice_statement_m
Class transaction_services_m
Update Version 74

Description

Returns the latest generated e-invoice XML for a given invoice, along with the statement's e-invoicing status and, when the latest attempt failed, its error code and message.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.

acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id

client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no

invoice_no long 22 Yes

The invoice to retrieve the latest e-invoice attempt for.

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.

error_msg string   No

Description of any error that occurred. "OK" if there was no error.

einvoice_seq_no long   No

The sequence number of the einvoice attempt. If the same invoice was sent multiple times, this identifies the exact instance returned (the latest attempt).

einvoice_status_ind long   No

The statement's e-invoicing status.

Allowed values:

Value Description
0 Pending
1 Done
2 Partial
3 Failed
4 Not Eligible
einvoice_error_code long   No

The error code recorded on the latest e-invoice attempt for the invoice when that attempt failed; NULL when the latest attempt succeeded.

einvoice_error_msg string   No

The message associated with einvoice_error_code; NULL when the latest attempt succeeded.

einvoice_data string   No

The generated e-invoice XML payload for the specified invoice.

TOP
  • Was this article helpful?