Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJarrResp
LOCAL lnRespStatusCode
LOCAL loDate_from
LOCAL loDate_to
LOCAL loJson
LOCAL lcLink
LOCAL lcCollected_at
LOCAL lcInvoice_identification
LOCAL lcInvoice_date
LOCAL lcStatus
LOCAL lcInvoice_type
LOCAL lcV_type
LOCAL lcSender_id
LOCAL lcSender_name
LOCAL lcReceiver_id
LOCAL lcReceiver_name
LOCAL lcCancelation_status
LOCAL lcCancelation_update_date
LOCAL lcCertification_date
LOCAL lcCertification_authority
LOCAL lcPayment_type
LOCAL lcPayment_type_description
LOCAL lcPayment_method
LOCAL lcPayment_method_description
LOCAL lcUsage
LOCAL lcVersion
LOCAL lcPlace_of_issue
LOCAL lcV_currency
LOCAL lcSubtotal_amount
LOCAL lcExchange_rate
LOCAL lcTax_amount
LOCAL lcDiscount_amount
LOCAL lcTotal_amount
LOCAL lcDays
LOCAL lcV_Type
LOCAL lcAmount
LOCAL lcVersion
LOCAL lcCollected_at
LOCAL lcPayment_date
LOCAL lcXml
LOCAL lcCode
LOCAL lcMessage
LOCAL j
LOCAL lnCount_j
LOCAL lcDescription
LOCAL lcProduct_identification
LOCAL lcQuantity
LOCAL lcUnit_code
LOCAL lcUnit_description
LOCAL lcUnit_amount
LOCAL lcPre_tax_amount
LOCAL lcTax_percentage
LOCAL k
LOCAL lnCount_k
LOCAL lcTax
LOCAL lcRetained_tax_amount
LOCAL lcDate
LOCAL lcAmount
LOCAL lcOperation_number
LOCAL lcBeneficiary_rfc
LOCAL lcBeneficiary_account_number
LOCAL lcPayer_rfc
LOCAL lcPayer_account_number
LOCAL lcPayer_bank_name
LOCAL lcPartiality_number
LOCAL lcPrevious_balance
LOCAL lcAmount_paid
LOCAL lcOutstanding_balance
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "{{secretId}}"
loHttp.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
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("date_from","2020-01-01")
loJson.UpdateString("date_to","2020-02-01")
loJson.UpdateString("link","d4617561-1c01-4b2f-83b6-a594f7b3bc57")
loJson.UpdateString("type","OUTFLOW")
loJson.UpdateBool("attach_xml",0)
loJson.UpdateBool("save_data",1)
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://domain.com/api/invoices/","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonArray')
loJarrResp = CreateObject('Chilkat.JsonArray')
loJarrResp.LoadSb(loSbResponseBody)
loJarrResp.EmitCompact = 0
? "Response Body:"
? loJarrResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJarrResp
CANCEL
ENDIF
RELEASE loResp
* 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
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_from = CreateObject('Chilkat.DtObj')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_to = CreateObject('Chilkat.DtObj')
i = 0
lnCount_i = loJarrResp.Size
DO WHILE i < lnCount_i
loJson = loJarrResp.ObjectAt(i)
lcLink = loJson.StringOf("link")
lcCollected_at = loJson.StringOf("collected_at")
lcInvoice_identification = loJson.StringOf("invoice_identification")
lcInvoice_date = loJson.StringOf("invoice_date")
lcStatus = loJson.StringOf("status")
lcInvoice_type = loJson.StringOf("invoice_type")
lcV_type = loJson.StringOf("type")
lcSender_id = loJson.StringOf("sender_id")
lcSender_name = loJson.StringOf("sender_name")
lcReceiver_id = loJson.StringOf("receiver_id")
lcReceiver_name = loJson.StringOf("receiver_name")
lcCancelation_status = loJson.StringOf("cancelation_status")
lcCancelation_update_date = loJson.StringOf("cancelation_update_date")
lcCertification_date = loJson.StringOf("certification_date")
lcCertification_authority = loJson.StringOf("certification_authority")
lcPayment_type = loJson.StringOf("payment_type")
lcPayment_type_description = loJson.StringOf("payment_type_description")
lcPayment_method = loJson.StringOf("payment_method")
lcPayment_method_description = loJson.StringOf("payment_method_description")
lcUsage = loJson.StringOf("usage")
lcVersion = loJson.StringOf("version")
lcPlace_of_issue = loJson.StringOf("place_of_issue")
lcV_currency = loJson.StringOf("currency")
lcSubtotal_amount = loJson.StringOf("subtotal_amount")
lcExchange_rate = loJson.StringOf("exchange_rate")
lcTax_amount = loJson.StringOf("tax_amount")
lcDiscount_amount = loJson.StringOf("discount_amount")
lcTotal_amount = loJson.StringOf("total_amount")
lcDays = loJson.StringOf("payroll.days")
lcV_Type = loJson.StringOf("payroll.type")
lcAmount = loJson.StringOf("payroll.amount")
lcVersion = loJson.StringOf("payroll.version")
loJson.DtOf("payroll.date_from",0,loDate_from)
loJson.DtOf("payroll.date_to",0,loDate_to)
lcCollected_at = loJson.StringOf("payroll.collected_at")
lcPayment_date = loJson.StringOf("payroll.payment_date")
lcXml = loJson.StringOf("xml")
lcCode = loJson.StringOf("warnings.code")
lcMessage = loJson.StringOf("warnings.message")
j = 0
lnCount_j = loJson.SizeOfArray("invoice_details")
DO WHILE j < lnCount_j
loJson.J = j
lcDescription = loJson.StringOf("invoice_details[j].description")
lcProduct_identification = loJson.StringOf("invoice_details[j].product_identification")
lcQuantity = loJson.StringOf("invoice_details[j].quantity")
lcUnit_code = loJson.StringOf("invoice_details[j].unit_code")
lcUnit_description = loJson.StringOf("invoice_details[j].unit_description")
lcUnit_amount = loJson.StringOf("invoice_details[j].unit_amount")
lcPre_tax_amount = loJson.StringOf("invoice_details[j].pre_tax_amount")
lcTax_percentage = loJson.StringOf("invoice_details[j].tax_percentage")
lcTax_amount = loJson.StringOf("invoice_details[j].tax_amount")
lcTotal_amount = loJson.StringOf("invoice_details[j].total_amount")
lcCollected_at = loJson.StringOf("invoice_details[j].collected_at")
k = 0
lnCount_k = loJson.SizeOfArray("invoice_details[j].retained_taxes")
DO WHILE k < lnCount_k
loJson.K = k
lcCollected_at = loJson.StringOf("invoice_details[j].retained_taxes[k].collected_at")
lcTax = loJson.StringOf("invoice_details[j].retained_taxes[k].tax")
lcTax_percentage = loJson.StringOf("invoice_details[j].retained_taxes[k].tax_percentage")
lcRetained_tax_amount = loJson.StringOf("invoice_details[j].retained_taxes[k].retained_tax_amount")
k = k + 1
ENDDO
j = j + 1
ENDDO
j = 0
lnCount_j = loJson.SizeOfArray("payments")
DO WHILE j < lnCount_j
loJson.J = j
lcDate = loJson.StringOf("payments[j].date")
lcPayment_type = loJson.StringOf("payments[j].payment_type")
lcV_currency = loJson.StringOf("payments[j].currency")
lcExchange_rate = loJson.StringOf("payments[j].exchange_rate")
lcAmount = loJson.StringOf("payments[j].amount")
lcOperation_number = loJson.StringOf("payments[j].operation_number")
lcBeneficiary_rfc = loJson.StringOf("payments[j].beneficiary_rfc")
lcBeneficiary_account_number = loJson.StringOf("payments[j].beneficiary_account_number")
lcPayer_rfc = loJson.StringOf("payments[j].payer_rfc")
lcPayer_account_number = loJson.StringOf("payments[j].payer_account_number")
lcPayer_bank_name = loJson.StringOf("payments[j].payer_bank_name")
k = 0
lnCount_k = loJson.SizeOfArray("payments[j].related_documents")
DO WHILE k < lnCount_k
loJson.K = k
lcInvoice_identification = loJson.StringOf("payments[j].related_documents[k].invoice_identification")
lcV_currency = loJson.StringOf("payments[j].related_documents[k].currency")
lcPayment_method = loJson.StringOf("payments[j].related_documents[k].payment_method")
lcPartiality_number = loJson.StringOf("payments[j].related_documents[k].partiality_number")
lcPrevious_balance = loJson.StringOf("payments[j].related_documents[k].previous_balance")
lcAmount_paid = loJson.StringOf("payments[j].related_documents[k].amount_paid")
lcOutstanding_balance = loJson.StringOf("payments[j].related_documents[k].outstanding_balance")
k = k + 1
ENDDO
j = j + 1
ENDDO
RELEASE loJson
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJarrResp
RELEASE loDate_from
RELEASE loDate_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]"
}
]
}
