List Invoices

ENDPOINT TO LIST INVOICES

If and invoice do not existis with this number/serie wil be created else updated

Request object has the following properties:

AttributeTypeDescription
files typestringReturn the file type.
Values:
danfe_authorization
xml_authorization
danfe_cancellation
xml_cancellation
danfe_correction_letter
xml_correction_letter
other_xml
other_danfe
nfe_typestringInforms the type of invoice.
nfe_statusstringInform the invoice status.
Values:
authorized
canceled
forbidden_disablement
others

FILTERS

  • created: yy-mm-dd or yy-mm-ddtoyy-mm-dd
  • modified: yy-mm-dd or yy-mm-ddtoyy-mm-dd
  • Any attribute returned is also filterable

Returned Exemple

{
    "total": 5,
    "showing": 5,
    "limit": 50,
    "hash_prev": "2021-06-09T19:43:20.899Z",
    "hash_next": "2021-06-09T19:32:07.650Z",
    "result": [
        {
            "Invoice": {
                "files": [
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/6694d63c22b4-2c88-46d1-9b4f-4418d5c8b164.com/users/93092400/invoices/documents/xml/463570080/authorized",
                        "type": "xml_authorization",
                        "id": "60c119da09d2ae60a58b6771"
                    },
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/66941803a66a-3dc3-480a-a1cb-c8a1823cf37e.com/users/93092400/invoices/sites/MLB/documents/danfe/463570080",
                        "type": "danfe_authorization",
                        "id": "60c119da09d2ae60a58b6775"
                    },
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/66940980e159-94d3-42be-9933-607c2d3ecb7a.com/users/93092400/invoices/documents/xml/463570080/canceled",
                        "type": "xml_cancellation",
                        "id": "60c119da09d2ae60a58b6776"
                    }
                ],
                "log_history": [],
                "user_id": "129",
                "number": "135464",
                "nfe_serie": "1",
                "xml_version": "4.00",
                "app_origin": "mercadolivre",
                "app_sub_origin": "4SALE$",
                "reference_order": "60c1198d36063670f6a083c0",
                "nfe_type": "sale",
                "nfe_key": "35210618232649000111550020001350641201920500",
                "nfe_date": "2021-06-09T16:38:40.896Z",
                "nfe_creation_date": "2021-06-09T16:38:40.000Z",
                "nfe_protocol": "2021-06-09T16:38:40.896Z",
                "nfe_receipt": "351007539174418",
                "nfe_receipt_date": "2021-06-09T16:38:43.000Z",
                "nfe_authorization_date": "2021-06-09T16:38:46.000Z",
                "nfe_status": "canceled",
                "modified": "2021-06-09T19:43:20.899Z",
                "modified_by": "NTJhYTI3MTc4MDYyZjNk",
                "created": "2021-06-09T19:43:20.899Z",
                "created_by": "NTJhYTI3MTc4MDYyZjNk",
                "nfe_cancellation_error_code": "690",
                "nfe_cancellation_error_description": "Rejeição: Pedido de Cancelamento para NF-e com CT-e ou MDF-e",
                "nfe_cancellation_reason": "Motivo do cancelamento: Pedido cancelado",
                "nfe_cancellation_date": "2021-06-09T18:40:06.000Z",
                "nfe_cancellation_protocol": "135211641030063",
                "group_id": null,
                "nfe_correction_letter_protocol": null,
                "id": "60c119d809d2ae60a58b676b"
            }
        },
        {
            "Invoice": {
                "files": [
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/66947edb6dee-6e82-4d4a-bab2-723e01aa5467.com/users/93092400/invoices/documents/xml/463781327/authorized",
                        "type": "xml_authorization",
                        "id": "60c1192cdf5f5f18b1049295"
                    },
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/6694c8fb5e03-6eeb-44c5-962b-80272877c066.com/users/93092400/invoices/sites/MLB/documents/danfe/463781327",
                        "type": "danfe_authorization",
                        "id": "60c1192cdf5f5f18b1049297"
                    }
                ],
                "log_history": [],
                "user_id": "129",
                "number": "135110",
                "nfe_serie": "2",
                "xml_version": "4.00",
                "app_origin": "mercadolivre",
                "reference_order": "60bf664ae8937025962f6a0c",
                "app_sub_origin": "4SALE$",
                "nfe_type": "inbound",
                "nfe_key": "35210618232641000101550020001350991756071712",
                "nfe_date": "2021-06-09T18:41:50.717Z",
                "nfe_creation_date": "2021-06-09T18:41:50.000Z",
                "nfe_protocol": "2021-06-09T18:41:50.717Z",
                "nfe_receipt": "351006539916966",
                "nfe_receipt_date": "2021-06-09T18:41:55.000Z",
                "nfe_authorization_date": "2021-06-09T18:41:59.000Z",
                "nfe_status": "authorized",
                "modified": "2021-06-09T19:40:26.199Z",
                "modified_by": "NTJhYTI3MTc4MDYyZjNk",
                "created": "2021-06-09T19:40:26.199Z",
                "created_by": "NTJhYTI3MTc4MDYyZjNk",
                "group_id": null,
                "nfe_cancellation_protocol": null,
                "nfe_correction_letter_protocol": null,
                "nfe_cancellation_date": null,
                "nfe_cancellation_reason": null,
                "nfe_cancellation_error_code": null,
                "nfe_cancellation_error_description": null,
                "id": "60c1192adf5f5f18b104928b"
            }
        },
        {
            "Invoice": {
                "files": [
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/6694ef9c24b7-2190-4129-b3e9-3d820ce20e2f.com/users/93092400/invoices/documents/xml/463808529/authorized",
                        "type": "xml_authorization",
                        "id": "60c1188289fc2d0188231016"
                    },
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/6694e1c325a4-eaaa-4ab2-a394-70e60d411777.com/users/93092400/invoices/sites/MLB/documents/danfe/463808529",
                        "type": "danfe_authorization",
                        "id": "60c1188289fc2d0188231017"
                    }
                ],
                "log_history": [],
                "user_id": "129",
                "number": "125104",
                "nfe_serie": "2",
                "xml_version": "4.00",
                "app_origin": "mercadolivre",
                "app_sub_origin": "4SALE$",
                "reference_order": "60ba3e17246e594a720f2684",
                "nfe_type": "sale",
                "nfe_key": "35210618232647000101550020001351041549947703",
                "nfe_date": "2021-06-09T19:01:31.169Z",
                "nfe_creation_date": "2021-06-09T19:01:31.000Z",
                "nfe_protocol": "2021-06-09T19:01:31.169Z",
                "nfe_receipt": "351017540039920",
                "nfe_receipt_date": "2021-06-09T19:01:35.000Z",
                "nfe_authorization_date": "2021-06-09T19:01:39.000Z",
                "nfe_status": "authorized",
                "modified": "2021-06-09T19:37:36.293Z",
                "modified_by": "NTJhYTI3MTc4MDYyZjNk",
                "created": "2021-06-09T19:37:36.293Z",
                "created_by": "NTJhYTI3MTc4MDYyZjNk",
                "group_id": null,
                "nfe_cancellation_protocol": null,
                "nfe_correction_letter_protocol": null,
                "nfe_cancellation_date": null,
                "nfe_cancellation_reason": null,
                "nfe_cancellation_error_code": null,
                "nfe_cancellation_error_description": null,
                "id": "60c1188089fc2d0188230ff3"
            }
        },
        {
            "Invoice": {
                "files": [
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/6694f7ccdc07-4507-4598-b104-804958fb5567.com/users/93092400/invoices/documents/xml/463739800/authorized",
                        "type": "xml_authorization",
                        "id": "60c117e4e9477925b11b3233"
                    },
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/66946903ecdf-6b62-4316-8943-77c5b87e520f.com/users/93092400/invoices/sites/MLB/documents/danfe/463739800",
                        "type": "danfe_authorization",
                        "id": "60c117e4e9477925b11b323a"
                    }
                ],
                "log_history": [],
                "user_id": "129",
                "number": "135771",
                "nfe_serie": "1",
                "xml_version": "4.00",
                "app_origin": "mercadolivre",
                "app_sub_origin": "4SALE$",
                "reference_order": "60ba3de786dc5d0b8b8ab50e",
                "nfe_type": "sale",
                "nfe_key": "35210611232649000101550020001350911014765146",
                "nfe_date": "2021-06-09T18:14:21.564Z",
                "nfe_creation_date": "2021-06-09T18:14:21.000Z",
                "nfe_protocol": "2021-06-09T18:14:21.564Z",
                "nfe_receipt": "351057539742849",
                "nfe_receipt_date": "2021-06-09T18:14:24.000Z",
                "nfe_authorization_date": "2021-06-09T18:14:26.000Z",
                "nfe_status": "authorized",
                "modified": "2021-06-09T19:34:58.918Z",
                "modified_by": "NTJhYTI3MTc4MDYyZjNk",
                "created": "2021-06-09T19:34:58.918Z",
                "created_by": "NTJhYTI3MTc4MDYyZjNk",
                "nfe_cancellation_error_code": "690",
                "nfe_cancellation_error_description": "Rejeição: Pedido de Cancelamento para NF-e com CT-e ou MDF-e",
                "nfe_cancellation_reason": "Motivo do cancelamento: cancelamento de nfe",
                "group_id": null,
                "nfe_cancellation_protocol": null,
                "nfe_correction_letter_protocol": null,
                "nfe_cancellation_date": null,
                "id": "60c117e2e9477925b11b3220"
            }
        },
        {
            "Invoice": {
                "files": [
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/6694fb8b8909-fc41-4b4b-8cac-35c0933f951d.com/users/93092400/invoices/documents/xml/463839741/authorized",
                        "type": "xml_authorization",
                        "id": "60c117391d3efa72a3944b5d"
                    },
                    {
                        "url": "https://s3-sa-east-1.amazonaws.com/pluggto-documents/129/6694ef1dfac3-c0c9-4851-b31d-ed35698fb4b1.com/users/93092400/invoices/sites/MLB/documents/danfe/463839741",
                        "type": "danfe_authorization",
                        "id": "60c1173a1d3efa72a3944b5e"
                    }
                ],
                "log_history": [],
                "user_id": "129",
                "number": "135207",
                "nfe_serie": "2",
                "xml_version": "4.00",
                "app_origin": "mercadolivre",
                "app_sub_origin": "4SALE$",
                "reference_order": "609a7eea109a305ce6299d8b",
                "nfe_type": "sale_return",
                "nfe_key": "35211618232649000101550020001351071051084370",
                "nfe_date": "2021-06-09T19:26:05.572Z",
                "nfe_creation_date": "2021-06-09T19:26:05.000Z",
                "nfe_protocol": "2021-06-09T19:26:05.572Z",
                "nfe_receipt": "341007540187215",
                "nfe_receipt_date": "2021-06-09T19:26:09.000Z",
                "nfe_authorization_date": "2021-06-09T19:26:11.000Z",
                "nfe_status": "authorized",
                "modified": "2021-06-09T19:32:07.650Z",
                "modified_by": "NTJhYTI3MTc4MDYyZjNk",
                "created": "2021-06-09T19:32:07.650Z",
                "created_by": "NTJhYTI3MTc4MDYyZjNk",
                "group_id": null,
                "nfe_cancellation_protocol": null,
                "nfe_correction_letter_protocol": null,
                "nfe_cancellation_date": null,
                "nfe_cancellation_reason": null,
                "nfe_cancellation_error_code": null,
                "nfe_cancellation_error_description": null,
                "id": "60c117371d3efa72a3944b44"
            }
        }
    ]
}
Language
Click Try It! to start a request and see the response here!