Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "{{secretId}}"
$oHttp.Password = "{{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
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("date_from","2020-01-01")
$oJson.UpdateString("date_to","2020-02-01")
$oJson.UpdateString("link","d4617561-1c01-4b2f-83b6-a594f7b3bc57")
$oJson.UpdateString("type","OUTFLOW")
$oJson.UpdateBool("attach_xml",False)
$oJson.UpdateBool("save_data",True)
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://domain.com/api/invoices/","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJarrResp = ObjCreate("Chilkat.JsonArray")
$oJarrResp.LoadSb($oSbResponseBody)
$oJarrResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJarrResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
$oDate_from = ObjCreate("Chilkat.DtObj")
$oDate_to = ObjCreate("Chilkat.DtObj")
Local $oJson
Local $sLink
Local $sCollected_at
Local $sInvoice_identification
Local $sInvoice_date
Local $status
Local $sInvoice_type
Local $sV_type
Local $sender_id
Local $sender_name
Local $sReceiver_id
Local $sReceiver_name
Local $sCancelation_status
Local $sCancelation_update_date
Local $sCertification_date
Local $sCertification_authority
Local $sPayment_type
Local $sPayment_type_description
Local $sPayment_method
Local $sPayment_method_description
Local $sUsage
Local $sVersion
Local $sPlace_of_issue
Local $sV_currency
Local $subtotal_amount
Local $sExchange_rate
Local $sTax_amount
Local $sDiscount_amount
Local $sTotal_amount
Local $sDays
Local $sV_Type
Local $sAmount
Local $sVersion
Local $sCollected_at
Local $sPayment_date
Local $sXml
Local $sCode
Local $sMessage
Local $iJ
Local $iCount_j
Local $sDescription
Local $sProduct_identification
Local $sQuantity
Local $sUnit_code
Local $sUnit_description
Local $sUnit_amount
Local $sPre_tax_amount
Local $sTax_percentage
Local $iK
Local $iCount_k
Local $sTax
Local $sRetained_tax_amount
Local $sDate
Local $sAmount
Local $sOperation_number
Local $sBeneficiary_rfc
Local $sBeneficiary_account_number
Local $sPayer_rfc
Local $sPayer_account_number
Local $sPayer_bank_name
Local $sPartiality_number
Local $sPrevious_balance
Local $sAmount_paid
Local $sOutstanding_balance
Local $i = 0
Local $iCount_i = $oJarrResp.Size
While $i < $iCount_i
$oJson = $oJarrResp.ObjectAt($i)
$sLink = $oJson.StringOf("link")
$sCollected_at = $oJson.StringOf("collected_at")
$sInvoice_identification = $oJson.StringOf("invoice_identification")
$sInvoice_date = $oJson.StringOf("invoice_date")
$status = $oJson.StringOf("status")
$sInvoice_type = $oJson.StringOf("invoice_type")
$sV_type = $oJson.StringOf("type")
$sender_id = $oJson.StringOf("sender_id")
$sender_name = $oJson.StringOf("sender_name")
$sReceiver_id = $oJson.StringOf("receiver_id")
$sReceiver_name = $oJson.StringOf("receiver_name")
$sCancelation_status = $oJson.StringOf("cancelation_status")
$sCancelation_update_date = $oJson.StringOf("cancelation_update_date")
$sCertification_date = $oJson.StringOf("certification_date")
$sCertification_authority = $oJson.StringOf("certification_authority")
$sPayment_type = $oJson.StringOf("payment_type")
$sPayment_type_description = $oJson.StringOf("payment_type_description")
$sPayment_method = $oJson.StringOf("payment_method")
$sPayment_method_description = $oJson.StringOf("payment_method_description")
$sUsage = $oJson.StringOf("usage")
$sVersion = $oJson.StringOf("version")
$sPlace_of_issue = $oJson.StringOf("place_of_issue")
$sV_currency = $oJson.StringOf("currency")
$subtotal_amount = $oJson.StringOf("subtotal_amount")
$sExchange_rate = $oJson.StringOf("exchange_rate")
$sTax_amount = $oJson.StringOf("tax_amount")
$sDiscount_amount = $oJson.StringOf("discount_amount")
$sTotal_amount = $oJson.StringOf("total_amount")
$sDays = $oJson.StringOf("payroll.days")
$sV_Type = $oJson.StringOf("payroll.type")
$sAmount = $oJson.StringOf("payroll.amount")
$sVersion = $oJson.StringOf("payroll.version")
$oJson.DtOf("payroll.date_from",False,$oDate_from)
$oJson.DtOf("payroll.date_to",False,$oDate_to)
$sCollected_at = $oJson.StringOf("payroll.collected_at")
$sPayment_date = $oJson.StringOf("payroll.payment_date")
$sXml = $oJson.StringOf("xml")
$sCode = $oJson.StringOf("warnings.code")
$sMessage = $oJson.StringOf("warnings.message")
$iJ = 0
$iCount_j = $oJson.SizeOfArray("invoice_details")
While $iJ < $iCount_j
$oJson.J = $iJ
$sDescription = $oJson.StringOf("invoice_details[j].description")
$sProduct_identification = $oJson.StringOf("invoice_details[j].product_identification")
$sQuantity = $oJson.StringOf("invoice_details[j].quantity")
$sUnit_code = $oJson.StringOf("invoice_details[j].unit_code")
$sUnit_description = $oJson.StringOf("invoice_details[j].unit_description")
$sUnit_amount = $oJson.StringOf("invoice_details[j].unit_amount")
$sPre_tax_amount = $oJson.StringOf("invoice_details[j].pre_tax_amount")
$sTax_percentage = $oJson.StringOf("invoice_details[j].tax_percentage")
$sTax_amount = $oJson.StringOf("invoice_details[j].tax_amount")
$sTotal_amount = $oJson.StringOf("invoice_details[j].total_amount")
$sCollected_at = $oJson.StringOf("invoice_details[j].collected_at")
$iK = 0
$iCount_k = $oJson.SizeOfArray("invoice_details[j].retained_taxes")
While $iK < $iCount_k
$oJson.K = $iK
$sCollected_at = $oJson.StringOf("invoice_details[j].retained_taxes[k].collected_at")
$sTax = $oJson.StringOf("invoice_details[j].retained_taxes[k].tax")
$sTax_percentage = $oJson.StringOf("invoice_details[j].retained_taxes[k].tax_percentage")
$sRetained_tax_amount = $oJson.StringOf("invoice_details[j].retained_taxes[k].retained_tax_amount")
$iK = $iK + 1
Wend
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJson.SizeOfArray("payments")
While $iJ < $iCount_j
$oJson.J = $iJ
$sDate = $oJson.StringOf("payments[j].date")
$sPayment_type = $oJson.StringOf("payments[j].payment_type")
$sV_currency = $oJson.StringOf("payments[j].currency")
$sExchange_rate = $oJson.StringOf("payments[j].exchange_rate")
$sAmount = $oJson.StringOf("payments[j].amount")
$sOperation_number = $oJson.StringOf("payments[j].operation_number")
$sBeneficiary_rfc = $oJson.StringOf("payments[j].beneficiary_rfc")
$sBeneficiary_account_number = $oJson.StringOf("payments[j].beneficiary_account_number")
$sPayer_rfc = $oJson.StringOf("payments[j].payer_rfc")
$sPayer_account_number = $oJson.StringOf("payments[j].payer_account_number")
$sPayer_bank_name = $oJson.StringOf("payments[j].payer_bank_name")
$iK = 0
$iCount_k = $oJson.SizeOfArray("payments[j].related_documents")
While $iK < $iCount_k
$oJson.K = $iK
$sInvoice_identification = $oJson.StringOf("payments[j].related_documents[k].invoice_identification")
$sV_currency = $oJson.StringOf("payments[j].related_documents[k].currency")
$sPayment_method = $oJson.StringOf("payments[j].related_documents[k].payment_method")
$sPartiality_number = $oJson.StringOf("payments[j].related_documents[k].partiality_number")
$sPrevious_balance = $oJson.StringOf("payments[j].related_documents[k].previous_balance")
$sAmount_paid = $oJson.StringOf("payments[j].related_documents[k].amount_paid")
$sOutstanding_balance = $oJson.StringOf("payments[j].related_documents[k].outstanding_balance")
$iK = $iK + 1
Wend
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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]"
}
]
}
