Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonArray.h>
#import <CkoDtObj.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"{{secretId}}";
http.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
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"date_from" value: @"2020-01-01"];
[json UpdateString: @"date_to" value: @"2020-02-01"];
[json UpdateString: @"link" value: @"d4617561-1c01-4b2f-83b6-a594f7b3bc57"];
[json UpdateString: @"type" value: @"OUTFLOW"];
[json UpdateBool: @"attach_xml" value: NO];
[json UpdateBool: @"save_data" value: YES];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/api/invoices/" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonArray *jarrResp = [[CkoJsonArray alloc] init];
[jarrResp LoadSb: sbResponseBody];
jarrResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jarrResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
CkoDtObj *Date_from = [[CkoDtObj alloc] init];
CkoDtObj *Date_to = [[CkoDtObj alloc] init];
CkoJsonObject *json = 0;
NSString *link = 0;
NSString *collected_at = 0;
NSString *invoice_identification = 0;
NSString *invoice_date = 0;
NSString *status = 0;
NSString *invoice_type = 0;
NSString *v_type = 0;
NSString *sender_id = 0;
NSString *sender_name = 0;
NSString *receiver_id = 0;
NSString *receiver_name = 0;
NSString *cancelation_status = 0;
NSString *cancelation_update_date = 0;
NSString *certification_date = 0;
NSString *certification_authority = 0;
NSString *payment_type = 0;
NSString *payment_type_description = 0;
NSString *payment_method = 0;
NSString *payment_method_description = 0;
NSString *usage = 0;
NSString *version = 0;
NSString *place_of_issue = 0;
NSString *v_currency = 0;
NSString *subtotal_amount = 0;
NSString *exchange_rate = 0;
NSString *tax_amount = 0;
NSString *discount_amount = 0;
NSString *total_amount = 0;
NSString *Days = 0;
NSString *v_Type = 0;
NSString *Amount = 0;
NSString *Version = 0;
NSString *Collected_at = 0;
NSString *Payment_date = 0;
NSString *xml = 0;
NSString *Code = 0;
NSString *Message = 0;
int j;
int count_j;
NSString *description = 0;
NSString *product_identification = 0;
NSString *quantity = 0;
NSString *unit_code = 0;
NSString *unit_description = 0;
NSString *unit_amount = 0;
NSString *pre_tax_amount = 0;
NSString *tax_percentage = 0;
int k;
int count_k;
NSString *tax = 0;
NSString *retained_tax_amount = 0;
NSString *date = 0;
NSString *amount = 0;
NSString *operation_number = 0;
NSString *beneficiary_rfc = 0;
NSString *beneficiary_account_number = 0;
NSString *payer_rfc = 0;
NSString *payer_account_number = 0;
NSString *payer_bank_name = 0;
NSString *partiality_number = 0;
NSString *previous_balance = 0;
NSString *amount_paid = 0;
NSString *outstanding_balance = 0;
int i = 0;
int count_i = [jarrResp.Size intValue];
while (i < count_i) {
json = [jarrResp ObjectAt: [NSNumber numberWithInt: i]];
link = [json StringOf: @"link"];
collected_at = [json StringOf: @"collected_at"];
invoice_identification = [json StringOf: @"invoice_identification"];
invoice_date = [json StringOf: @"invoice_date"];
status = [json StringOf: @"status"];
invoice_type = [json StringOf: @"invoice_type"];
v_type = [json StringOf: @"type"];
sender_id = [json StringOf: @"sender_id"];
sender_name = [json StringOf: @"sender_name"];
receiver_id = [json StringOf: @"receiver_id"];
receiver_name = [json StringOf: @"receiver_name"];
cancelation_status = [json StringOf: @"cancelation_status"];
cancelation_update_date = [json StringOf: @"cancelation_update_date"];
certification_date = [json StringOf: @"certification_date"];
certification_authority = [json StringOf: @"certification_authority"];
payment_type = [json StringOf: @"payment_type"];
payment_type_description = [json StringOf: @"payment_type_description"];
payment_method = [json StringOf: @"payment_method"];
payment_method_description = [json StringOf: @"payment_method_description"];
usage = [json StringOf: @"usage"];
version = [json StringOf: @"version"];
place_of_issue = [json StringOf: @"place_of_issue"];
v_currency = [json StringOf: @"currency"];
subtotal_amount = [json StringOf: @"subtotal_amount"];
exchange_rate = [json StringOf: @"exchange_rate"];
tax_amount = [json StringOf: @"tax_amount"];
discount_amount = [json StringOf: @"discount_amount"];
total_amount = [json StringOf: @"total_amount"];
Days = [json StringOf: @"payroll.days"];
v_Type = [json StringOf: @"payroll.type"];
Amount = [json StringOf: @"payroll.amount"];
Version = [json StringOf: @"payroll.version"];
[json DtOf: @"payroll.date_from" bLocal: NO dt: Date_from];
[json DtOf: @"payroll.date_to" bLocal: NO dt: Date_to];
Collected_at = [json StringOf: @"payroll.collected_at"];
Payment_date = [json StringOf: @"payroll.payment_date"];
xml = [json StringOf: @"xml"];
Code = [json StringOf: @"warnings.code"];
Message = [json StringOf: @"warnings.message"];
j = 0;
count_j = [[json SizeOfArray: @"invoice_details"] intValue];
while (j < count_j) {
json.J = [NSNumber numberWithInt: j];
description = [json StringOf: @"invoice_details[j].description"];
product_identification = [json StringOf: @"invoice_details[j].product_identification"];
quantity = [json StringOf: @"invoice_details[j].quantity"];
unit_code = [json StringOf: @"invoice_details[j].unit_code"];
unit_description = [json StringOf: @"invoice_details[j].unit_description"];
unit_amount = [json StringOf: @"invoice_details[j].unit_amount"];
pre_tax_amount = [json StringOf: @"invoice_details[j].pre_tax_amount"];
tax_percentage = [json StringOf: @"invoice_details[j].tax_percentage"];
tax_amount = [json StringOf: @"invoice_details[j].tax_amount"];
total_amount = [json StringOf: @"invoice_details[j].total_amount"];
collected_at = [json StringOf: @"invoice_details[j].collected_at"];
k = 0;
count_k = [[json SizeOfArray: @"invoice_details[j].retained_taxes"] intValue];
while (k < count_k) {
json.K = [NSNumber numberWithInt: k];
collected_at = [json StringOf: @"invoice_details[j].retained_taxes[k].collected_at"];
tax = [json StringOf: @"invoice_details[j].retained_taxes[k].tax"];
tax_percentage = [json StringOf: @"invoice_details[j].retained_taxes[k].tax_percentage"];
retained_tax_amount = [json StringOf: @"invoice_details[j].retained_taxes[k].retained_tax_amount"];
k = k + 1;
}
j = j + 1;
}
j = 0;
count_j = [[json SizeOfArray: @"payments"] intValue];
while (j < count_j) {
json.J = [NSNumber numberWithInt: j];
date = [json StringOf: @"payments[j].date"];
payment_type = [json StringOf: @"payments[j].payment_type"];
v_currency = [json StringOf: @"payments[j].currency"];
exchange_rate = [json StringOf: @"payments[j].exchange_rate"];
amount = [json StringOf: @"payments[j].amount"];
operation_number = [json StringOf: @"payments[j].operation_number"];
beneficiary_rfc = [json StringOf: @"payments[j].beneficiary_rfc"];
beneficiary_account_number = [json StringOf: @"payments[j].beneficiary_account_number"];
payer_rfc = [json StringOf: @"payments[j].payer_rfc"];
payer_account_number = [json StringOf: @"payments[j].payer_account_number"];
payer_bank_name = [json StringOf: @"payments[j].payer_bank_name"];
k = 0;
count_k = [[json SizeOfArray: @"payments[j].related_documents"] intValue];
while (k < count_k) {
json.K = [NSNumber numberWithInt: k];
invoice_identification = [json StringOf: @"payments[j].related_documents[k].invoice_identification"];
v_currency = [json StringOf: @"payments[j].related_documents[k].currency"];
payment_method = [json StringOf: @"payments[j].related_documents[k].payment_method"];
partiality_number = [json StringOf: @"payments[j].related_documents[k].partiality_number"];
previous_balance = [json StringOf: @"payments[j].related_documents[k].previous_balance"];
amount_paid = [json StringOf: @"payments[j].related_documents[k].amount_paid"];
outstanding_balance = [json StringOf: @"payments[j].related_documents[k].outstanding_balance"];
k = k + 1;
}
j = j + 1;
}
i = i + 1;
}
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]"
}
]
}
