Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "{{secretId}}"
CkHttp_put_Password $http "{{secretPassword}}"
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "date_from": "2020-01-01",
# "date_to": "2020-02-01",
# "link": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
# "type": "OUTFLOW",
# "attach_xml": false,
# "save_data": true
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "date_from" "2020-01-01"
CkJsonObject_UpdateString $json "date_to" "2020-02-01"
CkJsonObject_UpdateString $json "link" "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
CkJsonObject_UpdateString $json "type" "OUTFLOW"
CkJsonObject_UpdateBool $json "attach_xml" 0
CkJsonObject_UpdateBool $json "save_data" 1
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/api/invoices/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jarrResp [new_CkJsonArray]
CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0
puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# [
# {
# "link": "<string>",
# "collected_at": "<dateTime>",
# "invoice_identification": "<string>",
# "invoice_date": "<date>",
# "status": "<string>",
# "invoice_type": "<string>",
# "type": "incididunt exercitation anim dolore",
# "sender_id": "<string>",
# "sender_name": "<string>",
# "receiver_id": "<string>",
# "receiver_name": "<string>",
# "cancelation_status": "<string>",
# "cancelation_update_date": "<date>",
# "certification_date": "<date>",
# "certification_authority": "<string>",
# "payment_type": "<string>",
# "payment_type_description": "<string>",
# "payment_method": "<string>",
# "payment_method_description": "<string>",
# "usage": "<string>",
# "version": "<string>",
# "place_of_issue": "<string>",
# "invoice_details": [
# {
# "description": "<string>",
# "product_identification": "<string>",
# "quantity": "<integer>",
# "unit_code": "<string>",
# "unit_description": "<string>",
# "unit_amount": "<number>",
# "pre_tax_amount": "<number>",
# "tax_percentage": "<number>",
# "tax_amount": "<number>",
# "total_amount": "<number>",
# "retained_taxes": [
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# },
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# }
# ],
# "collected_at": "<dateTime>"
# },
# {
# "description": "<string>",
# "product_identification": "<string>",
# "quantity": "<integer>",
# "unit_code": "<string>",
# "unit_description": "<string>",
# "unit_amount": "<number>",
# "pre_tax_amount": "<number>",
# "tax_percentage": "<number>",
# "tax_amount": "<number>",
# "total_amount": "<number>",
# "retained_taxes": [
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# },
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# }
# ],
# "collected_at": "<dateTime>"
# }
# ],
# "currency": "<string>",
# "subtotal_amount": "<number>",
# "exchange_rate": "<number>",
# "tax_amount": "<number>",
# "discount_amount": "<number>",
# "total_amount": "<number>",
# "payments": [
# {
# "date": "<string>",
# "payment_type": "<string>",
# "currency": "<string>",
# "exchange_rate": "<string>",
# "amount": "<float>",
# "operation_number": "<string>",
# "beneficiary_rfc": "<string>",
# "beneficiary_account_number": "<string>",
# "payer_rfc": "<string>",
# "payer_account_number": "<string>",
# "payer_bank_name": "<string>",
# "related_documents": [
# {
# "invoice_identification": "<string>",
# "currency": "<string>",
# "payment_method": "<string>",
# "partiality_number": "<integer>",
# "previous_balance": "<float>",
# "amount_paid": "<float>",
# "outstanding_balance": "<float>"
# },
# {
# "invoice_identification": "<string>",
# "currency": "<string>",
# "payment_method": "<string>",
# "partiality_number": "<integer>",
# "previous_balance": "<float>",
# "amount_paid": "<float>",
# "outstanding_balance": "<float>"
# }
# ]
# },
# {
# "date": "<string>",
# "payment_type": "<string>",
# "currency": "<string>",
# "exchange_rate": "<string>",
# "amount": "<float>",
# "operation_number": "<string>",
# "beneficiary_rfc": "<string>",
# "beneficiary_account_number": "<string>",
# "payer_rfc": "<string>",
# "payer_account_number": "<string>",
# "payer_bank_name": "<string>",
# "related_documents": [
# {
# "invoice_identification": "<string>",
# "currency": "<string>",
# "payment_method": "<string>",
# "partiality_number": "<integer>",
# "previous_balance": "<float>",
# "amount_paid": "<float>",
# "outstanding_balance": "<float>"
# },
# {
# "invoice_identification": "<string>",
# "currency": "<string>",
# "payment_method": "<string>",
# "partiality_number": "<integer>",
# "previous_balance": "<float>",
# "amount_paid": "<float>",
# "outstanding_balance": "<float>"
# }
# ]
# }
# ],
# "payroll": {
# "days": "<number>",
# "type": "<string>",
# "amount": "<number>",
# "version": "<string>",
# "date_from": "<date>",
# "date_to": "<date>",
# "collected_at": "<dateTime>",
# "payment_date": "<date>"
# },
# "xml": "<string>",
# "warnings": {
# "code": "<string>",
# "message": "<string>"
# }
# },
# {
# "link": "<string>",
# "collected_at": "<dateTime>",
# "invoice_identification": "<string>",
# "invoice_date": "<date>",
# "status": "<string>",
# "invoice_type": "<string>",
# "type": "non in do qui",
# "sender_id": "<string>",
# "sender_name": "<string>",
# "receiver_id": "<string>",
# "receiver_name": "<string>",
# "cancelation_status": "<string>",
# "cancelation_update_date": "<date>",
# "certification_date": "<date>",
# "certification_authority": "<string>",
# "payment_type": "<string>",
# "payment_type_description": "<string>",
# "payment_method": "<string>",
# "payment_method_description": "<string>",
# "usage": "<string>",
# "version": "<string>",
# "place_of_issue": "<string>",
# "invoice_details": [
# {
# "description": "<string>",
# "product_identification": "<string>",
# "quantity": "<integer>",
# "unit_code": "<string>",
# "unit_description": "<string>",
# "unit_amount": "<number>",
# "pre_tax_amount": "<number>",
# "tax_percentage": "<number>",
# "tax_amount": "<number>",
# "total_amount": "<number>",
# "retained_taxes": [
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# },
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# }
# ],
# "collected_at": "<dateTime>"
# },
# {
# "description": "<string>",
# "product_identification": "<string>",
# "quantity": "<integer>",
# "unit_code": "<string>",
# "unit_description": "<string>",
# "unit_amount": "<number>",
# "pre_tax_amount": "<number>",
# "tax_percentage": "<number>",
# "tax_amount": "<number>",
# "total_amount": "<number>",
# "retained_taxes": [
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# },
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# }
# ],
# "collected_at": "<dateTime>"
# }
# ],
# "currency": "<string>",
# "subtotal_amount": "<number>",
# "exchange_rate": "<number>",
# "tax_amount": "<number>",
# "discount_amount": "<number>",
# "total_amount": "<number>",
# "payments": [
# {
# "date": "<string>",
# "payment_type": "<string>",
# "currency": "<string>",
# "exchange_rate": "<string>",
# "amount": "<float>",
# "operation_number": "<string>",
# "beneficiary_rfc": "<string>",
# "beneficiary_account_number": "<string>",
# "payer_rfc": "<string>",
# "payer_account_number": "<string>",
# "payer_bank_name": "<string>",
# "related_documents": [
# {
# "invoice_identification": "<string>",
# "currency": "<string>",
# "payment_method": "<string>",
# "partiality_number": "<integer>",
# "previous_balance": "<float>",
# "amount_paid": "<float>",
# "outstanding_balance": "<float>"
# },
# {
# "invoice_identification": "<string>",
# "currency": "<string>",
# "payment_method": "<string>",
# "partiality_number": "<integer>",
# "previous_balance": "<float>",
# "amount_paid": "<float>",
# "outstanding_balance": "<float>"
# }
# ]
# },
# {
# "date": "<string>",
# "payment_type": "<string>",
# "currency": "<string>",
# "exchange_rate": "<string>",
# "amount": "<float>",
# "operation_number": "<string>",
# "beneficiary_rfc": "<string>",
# "beneficiary_account_number": "<string>",
# "payer_rfc": "<string>",
# "payer_account_number": "<string>",
# "payer_bank_name": "<string>",
# "related_documents": [
# {
# "invoice_identification": "<string>",
# "currency": "<string>",
# "payment_method": "<string>",
# "partiality_number": "<integer>",
# "previous_balance": "<float>",
# "amount_paid": "<float>",
# "outstanding_balance": "<float>"
# },
# {
# "invoice_identification": "<string>",
# "currency": "<string>",
# "payment_method": "<string>",
# "partiality_number": "<integer>",
# "previous_balance": "<float>",
# "amount_paid": "<float>",
# "outstanding_balance": "<float>"
# }
# ]
# }
# ],
# "payroll": {
# "days": "<number>",
# "type": "<string>",
# "amount": "<number>",
# "version": "<string>",
# "date_from": "<date>",
# "date_to": "<date>",
# "collected_at": "<dateTime>",
# "payment_date": "<date>"
# },
# "xml": "<string>",
# "warnings": {
# "code": "<string>",
# "message": "<string>"
# }
# }
# ]
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Date_from [new_CkDtObj]
set Date_to [new_CkDtObj]
# json is a CkJsonObject
set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
set json [CkJsonArray_ObjectAt $jarrResp $i]
set link [CkJsonObject_stringOf $json "link"]
set collected_at [CkJsonObject_stringOf $json "collected_at"]
set invoice_identification [CkJsonObject_stringOf $json "invoice_identification"]
set invoice_date [CkJsonObject_stringOf $json "invoice_date"]
set status [CkJsonObject_stringOf $json "status"]
set invoice_type [CkJsonObject_stringOf $json "invoice_type"]
set v_type [CkJsonObject_stringOf $json "type"]
set sender_id [CkJsonObject_stringOf $json "sender_id"]
set sender_name [CkJsonObject_stringOf $json "sender_name"]
set receiver_id [CkJsonObject_stringOf $json "receiver_id"]
set receiver_name [CkJsonObject_stringOf $json "receiver_name"]
set cancelation_status [CkJsonObject_stringOf $json "cancelation_status"]
set cancelation_update_date [CkJsonObject_stringOf $json "cancelation_update_date"]
set certification_date [CkJsonObject_stringOf $json "certification_date"]
set certification_authority [CkJsonObject_stringOf $json "certification_authority"]
set payment_type [CkJsonObject_stringOf $json "payment_type"]
set payment_type_description [CkJsonObject_stringOf $json "payment_type_description"]
set payment_method [CkJsonObject_stringOf $json "payment_method"]
set payment_method_description [CkJsonObject_stringOf $json "payment_method_description"]
set usage [CkJsonObject_stringOf $json "usage"]
set version [CkJsonObject_stringOf $json "version"]
set place_of_issue [CkJsonObject_stringOf $json "place_of_issue"]
set v_currency [CkJsonObject_stringOf $json "currency"]
set subtotal_amount [CkJsonObject_stringOf $json "subtotal_amount"]
set exchange_rate [CkJsonObject_stringOf $json "exchange_rate"]
set tax_amount [CkJsonObject_stringOf $json "tax_amount"]
set discount_amount [CkJsonObject_stringOf $json "discount_amount"]
set total_amount [CkJsonObject_stringOf $json "total_amount"]
set Days [CkJsonObject_stringOf $json "payroll.days"]
set v_Type [CkJsonObject_stringOf $json "payroll.type"]
set Amount [CkJsonObject_stringOf $json "payroll.amount"]
set Version [CkJsonObject_stringOf $json "payroll.version"]
CkJsonObject_DtOf $json "payroll.date_from" 0 $Date_from
CkJsonObject_DtOf $json "payroll.date_to" 0 $Date_to
set Collected_at [CkJsonObject_stringOf $json "payroll.collected_at"]
set Payment_date [CkJsonObject_stringOf $json "payroll.payment_date"]
set xml [CkJsonObject_stringOf $json "xml"]
set Code [CkJsonObject_stringOf $json "warnings.code"]
set Message [CkJsonObject_stringOf $json "warnings.message"]
set j 0
set count_j [CkJsonObject_SizeOfArray $json "invoice_details"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set description [CkJsonObject_stringOf $json "invoice_details[j].description"]
set product_identification [CkJsonObject_stringOf $json "invoice_details[j].product_identification"]
set quantity [CkJsonObject_stringOf $json "invoice_details[j].quantity"]
set unit_code [CkJsonObject_stringOf $json "invoice_details[j].unit_code"]
set unit_description [CkJsonObject_stringOf $json "invoice_details[j].unit_description"]
set unit_amount [CkJsonObject_stringOf $json "invoice_details[j].unit_amount"]
set pre_tax_amount [CkJsonObject_stringOf $json "invoice_details[j].pre_tax_amount"]
set tax_percentage [CkJsonObject_stringOf $json "invoice_details[j].tax_percentage"]
set tax_amount [CkJsonObject_stringOf $json "invoice_details[j].tax_amount"]
set total_amount [CkJsonObject_stringOf $json "invoice_details[j].total_amount"]
set collected_at [CkJsonObject_stringOf $json "invoice_details[j].collected_at"]
set k 0
set count_k [CkJsonObject_SizeOfArray $json "invoice_details[j].retained_taxes"]
while {$k < $count_k} {
CkJsonObject_put_K $json $k
set collected_at [CkJsonObject_stringOf $json "invoice_details[j].retained_taxes[k].collected_at"]
set tax [CkJsonObject_stringOf $json "invoice_details[j].retained_taxes[k].tax"]
set tax_percentage [CkJsonObject_stringOf $json "invoice_details[j].retained_taxes[k].tax_percentage"]
set retained_tax_amount [CkJsonObject_stringOf $json "invoice_details[j].retained_taxes[k].retained_tax_amount"]
set k [expr $k + 1]
}
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $json "payments"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set date [CkJsonObject_stringOf $json "payments[j].date"]
set payment_type [CkJsonObject_stringOf $json "payments[j].payment_type"]
set v_currency [CkJsonObject_stringOf $json "payments[j].currency"]
set exchange_rate [CkJsonObject_stringOf $json "payments[j].exchange_rate"]
set amount [CkJsonObject_stringOf $json "payments[j].amount"]
set operation_number [CkJsonObject_stringOf $json "payments[j].operation_number"]
set beneficiary_rfc [CkJsonObject_stringOf $json "payments[j].beneficiary_rfc"]
set beneficiary_account_number [CkJsonObject_stringOf $json "payments[j].beneficiary_account_number"]
set payer_rfc [CkJsonObject_stringOf $json "payments[j].payer_rfc"]
set payer_account_number [CkJsonObject_stringOf $json "payments[j].payer_account_number"]
set payer_bank_name [CkJsonObject_stringOf $json "payments[j].payer_bank_name"]
set k 0
set count_k [CkJsonObject_SizeOfArray $json "payments[j].related_documents"]
while {$k < $count_k} {
CkJsonObject_put_K $json $k
set invoice_identification [CkJsonObject_stringOf $json "payments[j].related_documents[k].invoice_identification"]
set v_currency [CkJsonObject_stringOf $json "payments[j].related_documents[k].currency"]
set payment_method [CkJsonObject_stringOf $json "payments[j].related_documents[k].payment_method"]
set partiality_number [CkJsonObject_stringOf $json "payments[j].related_documents[k].partiality_number"]
set previous_balance [CkJsonObject_stringOf $json "payments[j].related_documents[k].previous_balance"]
set amount_paid [CkJsonObject_stringOf $json "payments[j].related_documents[k].amount_paid"]
set outstanding_balance [CkJsonObject_stringOf $json "payments[j].related_documents[k].outstanding_balance"]
set k [expr $k + 1]
}
set j [expr $j + 1]
}
delete_CkJsonObject $json
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
delete_CkDtObj $Date_from
delete_CkDtObj $Date_to
Curl Command
curl -X POST
-u '{{secretId}}:{{secretPassword}}'
-H "Content-Type: application/json"
-d '{
"date_from": "2020-01-01",
"date_to": "2020-02-01",
"link": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
"type": "OUTFLOW",
"attach_xml": false,
"save_data": true
}'
https://domain.com/api/invoices/
Postman Collection Item JSON
{
"name": "Retrieve",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"2020-01-01\",\n \"date_to\": \"2020-02-01\",\n \"link\": \"d4617561-1c01-4b2f-83b6-a594f7b3bc57\",\n \"type\": \"OUTFLOW\",\n \"attach_xml\": false,\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/invoices/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
""
]
},
"description": "Retrieve invoice information from a specific fiscal link.\n\nℹ️ You can ask for up to **one** year (365 days) of invoices per request. If you need invoices for more than one year, just make another request.\n"
},
"response": [
{
"name": "Ok (when save_data=false)",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"type\": \"<string>\",\n \"attach_xml\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/invoices",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"link\": \"<string>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"invoice_identification\": \"<string>\",\n\t\t\"invoice_date\": \"<date>\",\n\t\t\"status\": \"<string>\",\n\t\t\"invoice_type\": \"<string>\",\n\t\t\"type\": \"incididunt exercitation anim dolore\",\n\t\t\"sender_id\": \"<string>\",\n\t\t\"sender_name\": \"<string>\",\n\t\t\"receiver_id\": \"<string>\",\n\t\t\"receiver_name\": \"<string>\",\n\t\t\"cancelation_status\": \"<string>\",\n\t\t\"cancelation_update_date\": \"<date>\",\n\t\t\"certification_date\": \"<date>\",\n\t\t\"certification_authority\": \"<string>\",\n\t\t\"payment_type\": \"<string>\",\n\t\t\"payment_type_description\": \"<string>\",\n\t\t\"payment_method\": \"<string>\",\n\t\t\"payment_method_description\": \"<string>\",\n\t\t\"usage\": \"<string>\",\n\t\t\"version\": \"<string>\",\n\t\t\"place_of_issue\": \"<string>\",\n\t\t\"invoice_details\": [\n\t\t\t{\n\t\t\t\t\"description\": \"<string>\",\n\t\t\t\t\"product_identification\": \"<string>\",\n\t\t\t\t\"quantity\": \"<integer>\",\n\t\t\t\t\"unit_code\": \"<string>\",\n\t\t\t\t\"unit_description\": \"<string>\",\n\t\t\t\t\"unit_amount\": \"<number>\",\n\t\t\t\t\"pre_tax_amount\": \"<number>\",\n\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\"tax_amount\": \"<number>\",\n\t\t\t\t\"total_amount\": \"<number>\",\n\t\t\t\t\"retained_taxes\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"collected_at\": \"<dateTime>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"description\": \"<string>\",\n\t\t\t\t\"product_identification\": \"<string>\",\n\t\t\t\t\"quantity\": \"<integer>\",\n\t\t\t\t\"unit_code\": \"<string>\",\n\t\t\t\t\"unit_description\": \"<string>\",\n\t\t\t\t\"unit_amount\": \"<number>\",\n\t\t\t\t\"pre_tax_amount\": \"<number>\",\n\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\"tax_amount\": \"<number>\",\n\t\t\t\t\"total_amount\": \"<number>\",\n\t\t\t\t\"retained_taxes\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"collected_at\": \"<dateTime>\"\n\t\t\t}\n\t\t],\n\t\t\"currency\": \"<string>\",\n\t\t\"subtotal_amount\": \"<number>\",\n\t\t\"exchange_rate\": \"<number>\",\n\t\t\"tax_amount\": \"<number>\",\n\t\t\"discount_amount\": \"<number>\",\n\t\t\"total_amount\": \"<number>\",\n\t\t\"payments\": [\n\t\t\t{\n\t\t\t\t\"date\": \"<string>\",\n\t\t\t\t\"payment_type\": \"<string>\",\n\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\"exchange_rate\": \"<string>\",\n\t\t\t\t\"amount\": \"<float>\",\n\t\t\t\t\"operation_number\": \"<string>\",\n\t\t\t\t\"beneficiary_rfc\": \"<string>\",\n\t\t\t\t\"beneficiary_account_number\": \"<string>\",\n\t\t\t\t\"payer_rfc\": \"<string>\",\n\t\t\t\t\"payer_account_number\": \"<string>\",\n\t\t\t\t\"payer_bank_name\": \"<string>\",\n\t\t\t\t\"related_documents\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"invoice_identification\": \"<string>\",\n\t\t\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\t\t\"partiality_number\": \"<integer>\",\n\t\t\t\t\t\t\"previous_balance\": \"<float>\",\n\t\t\t\t\t\t\"amount_paid\": \"<float>\",\n\t\t\t\t\t\t\"outstanding_balance\": \"<float>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"invoice_identification\": \"<string>\",\n\t\t\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\t\t\"partiality_number\": \"<integer>\",\n\t\t\t\t\t\t\"previous_balance\": \"<float>\",\n\t\t\t\t\t\t\"amount_paid\": \"<float>\",\n\t\t\t\t\t\t\"outstanding_balance\": \"<float>\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"date\": \"<string>\",\n\t\t\t\t\"payment_type\": \"<string>\",\n\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\"exchange_rate\": \"<string>\",\n\t\t\t\t\"amount\": \"<float>\",\n\t\t\t\t\"operation_number\": \"<string>\",\n\t\t\t\t\"beneficiary_rfc\": \"<string>\",\n\t\t\t\t\"beneficiary_account_number\": \"<string>\",\n\t\t\t\t\"payer_rfc\": \"<string>\",\n\t\t\t\t\"payer_account_number\": \"<string>\",\n\t\t\t\t\"payer_bank_name\": \"<string>\",\n\t\t\t\t\"related_documents\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"invoice_identification\": \"<string>\",\n\t\t\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\t\t\"partiality_number\": \"<integer>\",\n\t\t\t\t\t\t\"previous_balance\": \"<float>\",\n\t\t\t\t\t\t\"amount_paid\": \"<float>\",\n\t\t\t\t\t\t\"outstanding_balance\": \"<float>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"invoice_identification\": \"<string>\",\n\t\t\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\t\t\"partiality_number\": \"<integer>\",\n\t\t\t\t\t\t\"previous_balance\": \"<float>\",\n\t\t\t\t\t\t\"amount_paid\": \"<float>\",\n\t\t\t\t\t\t\"outstanding_balance\": \"<float>\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\t\"payroll\": {\n\t\t\t\"days\": \"<number>\",\n\t\t\t\"type\": \"<string>\",\n\t\t\t\"amount\": \"<number>\",\n\t\t\t\"version\": \"<string>\",\n\t\t\t\"date_from\": \"<date>\",\n\t\t\t\"date_to\": \"<date>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"payment_date\": \"<date>\"\n\t\t},\n\t\t\"xml\": \"<string>\",\n\t\t\"warnings\": {\n\t\t\t\"code\": \"<string>\",\n\t\t\t\"message\": \"<string>\"\n\t\t}\n\t},\n\t{\n\t\t\"link\": \"<string>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"invoice_identification\": \"<string>\",\n\t\t\"invoice_date\": \"<date>\",\n\t\t\"status\": \"<string>\",\n\t\t\"invoice_type\": \"<string>\",\n\t\t\"type\": \"non in do qui\",\n\t\t\"sender_id\": \"<string>\",\n\t\t\"sender_name\": \"<string>\",\n\t\t\"receiver_id\": \"<string>\",\n\t\t\"receiver_name\": \"<string>\",\n\t\t\"cancelation_status\": \"<string>\",\n\t\t\"cancelation_update_date\": \"<date>\",\n\t\t\"certification_date\": \"<date>\",\n\t\t\"certification_authority\": \"<string>\",\n\t\t\"payment_type\": \"<string>\",\n\t\t\"payment_type_description\": \"<string>\",\n\t\t\"payment_method\": \"<string>\",\n\t\t\"payment_method_description\": \"<string>\",\n\t\t\"usage\": \"<string>\",\n\t\t\"version\": \"<string>\",\n\t\t\"place_of_issue\": \"<string>\",\n\t\t\"invoice_details\": [\n\t\t\t{\n\t\t\t\t\"description\": \"<string>\",\n\t\t\t\t\"product_identification\": \"<string>\",\n\t\t\t\t\"quantity\": \"<integer>\",\n\t\t\t\t\"unit_code\": \"<string>\",\n\t\t\t\t\"unit_description\": \"<string>\",\n\t\t\t\t\"unit_amount\": \"<number>\",\n\t\t\t\t\"pre_tax_amount\": \"<number>\",\n\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\"tax_amount\": \"<number>\",\n\t\t\t\t\"total_amount\": \"<number>\",\n\t\t\t\t\"retained_taxes\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"collected_at\": \"<dateTime>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"description\": \"<string>\",\n\t\t\t\t\"product_identification\": \"<string>\",\n\t\t\t\t\"quantity\": \"<integer>\",\n\t\t\t\t\"unit_code\": \"<string>\",\n\t\t\t\t\"unit_description\": \"<string>\",\n\t\t\t\t\"unit_amount\": \"<number>\",\n\t\t\t\t\"pre_tax_amount\": \"<number>\",\n\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\"tax_amount\": \"<number>\",\n\t\t\t\t\"total_amount\": \"<number>\",\n\t\t\t\t\"retained_taxes\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"collected_at\": \"<dateTime>\"\n\t\t\t}\n\t\t],\n\t\t\"currency\": \"<string>\",\n\t\t\"subtotal_amount\": \"<number>\",\n\t\t\"exchange_rate\": \"<number>\",\n\t\t\"tax_amount\": \"<number>\",\n\t\t\"discount_amount\": \"<number>\",\n\t\t\"total_amount\": \"<number>\",\n\t\t\"payments\": [\n\t\t\t{\n\t\t\t\t\"date\": \"<string>\",\n\t\t\t\t\"payment_type\": \"<string>\",\n\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\"exchange_rate\": \"<string>\",\n\t\t\t\t\"amount\": \"<float>\",\n\t\t\t\t\"operation_number\": \"<string>\",\n\t\t\t\t\"beneficiary_rfc\": \"<string>\",\n\t\t\t\t\"beneficiary_account_number\": \"<string>\",\n\t\t\t\t\"payer_rfc\": \"<string>\",\n\t\t\t\t\"payer_account_number\": \"<string>\",\n\t\t\t\t\"payer_bank_name\": \"<string>\",\n\t\t\t\t\"related_documents\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"invoice_identification\": \"<string>\",\n\t\t\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\t\t\"partiality_number\": \"<integer>\",\n\t\t\t\t\t\t\"previous_balance\": \"<float>\",\n\t\t\t\t\t\t\"amount_paid\": \"<float>\",\n\t\t\t\t\t\t\"outstanding_balance\": \"<float>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"invoice_identification\": \"<string>\",\n\t\t\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\t\t\"partiality_number\": \"<integer>\",\n\t\t\t\t\t\t\"previous_balance\": \"<float>\",\n\t\t\t\t\t\t\"amount_paid\": \"<float>\",\n\t\t\t\t\t\t\"outstanding_balance\": \"<float>\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"date\": \"<string>\",\n\t\t\t\t\"payment_type\": \"<string>\",\n\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\"exchange_rate\": \"<string>\",\n\t\t\t\t\"amount\": \"<float>\",\n\t\t\t\t\"operation_number\": \"<string>\",\n\t\t\t\t\"beneficiary_rfc\": \"<string>\",\n\t\t\t\t\"beneficiary_account_number\": \"<string>\",\n\t\t\t\t\"payer_rfc\": \"<string>\",\n\t\t\t\t\"payer_account_number\": \"<string>\",\n\t\t\t\t\"payer_bank_name\": \"<string>\",\n\t\t\t\t\"related_documents\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"invoice_identification\": \"<string>\",\n\t\t\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\t\t\"partiality_number\": \"<integer>\",\n\t\t\t\t\t\t\"previous_balance\": \"<float>\",\n\t\t\t\t\t\t\"amount_paid\": \"<float>\",\n\t\t\t\t\t\t\"outstanding_balance\": \"<float>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"invoice_identification\": \"<string>\",\n\t\t\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\t\t\"payment_method\": \"<string>\",\n\t\t\t\t\t\t\"partiality_number\": \"<integer>\",\n\t\t\t\t\t\t\"previous_balance\": \"<float>\",\n\t\t\t\t\t\t\"amount_paid\": \"<float>\",\n\t\t\t\t\t\t\"outstanding_balance\": \"<float>\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\t\"payroll\": {\n\t\t\t\"days\": \"<number>\",\n\t\t\t\"type\": \"<string>\",\n\t\t\t\"amount\": \"<number>\",\n\t\t\t\"version\": \"<string>\",\n\t\t\t\"date_from\": \"<date>\",\n\t\t\t\"date_to\": \"<date>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"payment_date\": \"<date>\"\n\t\t},\n\t\t\"xml\": \"<string>\",\n\t\t\"warnings\": {\n\t\t\t\"code\": \"<string>\",\n\t\t\t\"message\": \"<string>\"\n\t\t}\n\t}\n]"
},
{
"name": "Created (when save_data=true)",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"type\": \"<string>\",\n \"attach_xml\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/invoices",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"description\": \"<string>\",\n\t\t\"product_identification\": \"<string>\",\n\t\t\"quantity\": \"<integer>\",\n\t\t\"unit_code\": \"<string>\",\n\t\t\"unit_description\": \"<string>\",\n\t\t\"unit_amount\": \"<number>\",\n\t\t\"pre_tax_amount\": \"<number>\",\n\t\t\"tax_percentage\": \"<number>\",\n\t\t\"tax_amount\": \"<number>\",\n\t\t\"total_amount\": \"<number>\",\n\t\t\"retained_taxes\": [\n\t\t\t{\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t}\n\t\t],\n\t\t\"collected_at\": \"<dateTime>\"\n\t},\n\t{\n\t\t\"description\": \"<string>\",\n\t\t\"product_identification\": \"<string>\",\n\t\t\"quantity\": \"<integer>\",\n\t\t\"unit_code\": \"<string>\",\n\t\t\"unit_description\": \"<string>\",\n\t\t\"unit_amount\": \"<number>\",\n\t\t\"pre_tax_amount\": \"<number>\",\n\t\t\"tax_percentage\": \"<number>\",\n\t\t\"tax_amount\": \"<number>\",\n\t\t\"total_amount\": \"<number>\",\n\t\t\"retained_taxes\": [\n\t\t\t{\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t}\n\t\t],\n\t\t\"collected_at\": \"<dateTime>\"\n\t}\n]"
},
{
"name": "Bad request error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"type\": \"<string>\",\n \"attach_xml\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/invoices",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"type\": \"<string>\",\n \"attach_xml\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/invoices",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Request Timeout",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"type\": \"<string>\",\n \"attach_xml\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/invoices",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices"
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Unexpected Error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"type\": \"<string>\",\n \"attach_xml\": false,\n \"encryption_key\": \"<string>\",\n \"save_data\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/api/invoices",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}
